この開発者 FAQ に貢献するにはどうしたら良いですか?

どのような貢献でもありがたいしぜひお願いしたいです。他の誰かが後日
「これはどうしたらよいのだろう...?」といった疑問で苦労したときに
こういった貢献は間違いなく感謝されるでしょう。

あたらしい FAQ を追加したり既存の FAQ を編集するには、まず最初に
アカウントを取得する必要があります。このページの右上にある "Log In"
をクリックして登録してください。

この FAQ に対して質問や提案があれば、
[docs@glassfish.java.net]
にコンタクトしてください。日本の皆さんは、
[discuss_ja@glassfish.java.net]
も使えます。こちらはもちろん日本語で OK です。メーリングリスト
の購読方法は、
グラジェーのこちらのページ
を参考にしてください。

貢献の方法

  • 回答を求められている、既存の質問への回答をポストする(メインページの Developer FAQ Wish Listにある質問リストへの回答)。もしかしたら皆さんも同じ問題で苦労されたことがあって、回答をお持ちかもしれません。その質問に対してブログを書いたことがあったり、同様の質問が過去にフォーラムなどに何度も投稿されていたかもしれません。もし皆さんの専門知識を共有して頂けるならぜひお願いします。
    • すでにあなたが回答を持っている新しい質問項目があればポストする。*念のため最初に同じ項目が現在の FAQ にないか確認してください(もしある場合は、次をご覧ください)。そして次にこの質問はしばしば聞かれるか考えてみてください。この問題はメーリングリストなどで多くの人が何回も聞いたり回答したりしてますか?多くの人(特に GlassFish に新しく参加した開発者)が疑問を抱いたり助けを必要とすると思いますか?もしそうであればぜひ追加してください。
    • 他の人が書いた FAQ に情報を追加する。*既存の FAQ を改良する情報をお持ちでしたら、ぜひお願いします。それは詳細な例(例はとても役に立ちます!)かもしれませんし、回避方法かもしれませんし、ちょっとした技術情報かもしれません。

FAQ のフォーマット

FAQ のエントリーは同じ命名法を使い、同じフォーマットにしましょう。
これはとても重要ですので、以下のことを守ってください。

    • Wiki ページの名前の先頭に "Faq" をつけます。*そしてそれに続く名前は短くて分かり易いものにしてください。例えば、このページの名前は FaqContributeToDeveloperFAQ です。なお、日本語版は、名前の最後に "Ja" をつけています。このページは "FaqContributeToDeveloperFAQJa" になります。
    • 適切なカテゴリに新しい FAQ を追加します。*メインの GlassFish Developer FAQ ページにカテゴリが無ければ、追加してください。また、メインページの目次に対応するエントリーを追加し、読む人に何が追加されたか分かり易いようにしてください。他のエントリーはこのメインページのフォーマットに従ってください。
    • 回答ページの最初にまず質問を書いて、その質問がメインページのリストと同じになるようにします。*例えば、「この開発者 FAQ に貢献するにはどうしたら良いですか?」という質問を、メインページと回答ページの先頭の両方に書いてください。修正が必要なミスマッチの例としては、「この開発者 FAQ に貢献するにはどうしたら良いですか?」という質問に対して、回答で「この FAQ への貢献」などです。
    • 回答の先頭にある質問は中サイズにします*(!! マークアップ記号)。例えば、このページの先頭にある「この開発者 FAQ に貢献するにはどうしたら良いですか?」は、ちょっと大きな文字と異なる色で表示されます。これは !! マークアップ記号を使っているからです。
    • いくつかの単純な編集ガイドラインに従います。"GlassFish" の名前で*F は大文字*です。例えば、Glassfish ではなくて*GlassFish*です。バージョン番号には*小文字の v を使ってください。例えば、V2 や V3 ではなくて*v2* や v3 です。またフルスペルの version ではなく*小文字の v* を使ってください。例えば、version 3 ではなくて*v3* です。この用法は wiki のなかで統一されてませんが、新しい記事を書く場合にはぜひ従ってください。

FAQ の内容のガイドライン

    • 上に書かれたフォーマットガイドラインに従ってください。* 統一されていることが重要です。
    • FAQ がユーザー向けではなく開発者向けであること*、GlassFish のユーザーではなく GlassFish の開発者向けの内容にしてください。ユーザー向けの質問はGlassFish ユーザー FAQを使ってください。
    • FAQ のタイトルは実際に聞かれるであろう質問にしてください。*タイトルは短くポイントを押さえるよう、また1行以内でそのトピックの簡単な概要になっていれば理想的です。

新しい FAQ を追加するには

  1. ページの先頭にある "Log In" をクリックして認証してください。アカウントが無い場合は、登録する必要があります。登録方法は、こちらをご覧ください。グラジェーのこちらのページも参考になります。
  2. 左側にある GlassFish Developer FAQ をクリックし、開発者 FAQ のページを表示します。日本語は、こちらになります。これで GlassFish 開発者 FAQ のページが表示されます。
  3. ページの最後にある "Edit" をクリックしてください。この編集オプションはログインしていない場合は有効ではありません。ログインしているけど編集オプションが表示されない場合は次の、「GlassFish Wiki ページを編集できないのですがなぜでしょう?」をご覧ください。
  4. 適切なカテゴリ(例えば Classloader)までスクロールし、他の質問で使っているフォーマットに従って、上にリスとされているガイドラインに注意を払って、リストに質問を追加します。重要: 新しいカテゴリを追加する場合は、目次にも対応するエントリを追加してください。他のエントリと同じフォーマットにしてください。
  5. エントリーをプレビュー(Preview)し、必要な変更をしたら保存(Save)します。
  6. GlassFish 開発者 FAQ ページのリストにある質問をクリックし、そのトピックのページに内容を追加します。
  7. 内容をプレビュー(Preview)し、必要な変更をしたら保存(Save)します。

既存の FAQ を編集するには

  1. ページの先頭にある "Log In" をクリックし、認証します。アカウントをお持ちでない場合は、登録する必要があります。詳細は、「登録するには?」をご覧ください。
  2. 左側の "GlassFish Developer FAQ" をクリックします。日本語の場合は、こちらをクリックしてください。GlassFish 開発者 FAQ ページが表示されます。
  3. 編集したい FAQ のリンクをクリックします。トピックページが表示されます。
  4. ページの最後の "Edit" をクリックします。ログインしていない場合は、この編集オプションは表示されません。ログインしているのに編集オプションが表示されない場合は、「GlassFish Wiki ページを編集できないのですがなぜでしょう?」をご覧ください。
  5. 表示されているページの内容を編集します。
  6. 変更をプレビュー(Preview)し、必要な修正を行ったら保存(Save)します。

日本の皆様へ

日本語 Wiki への貢献に興味のある方は、ぜひグラジェーのこちらのページをご覧ください。こちらでグラジェー有志による、FAQ の翻訳やブログの翻訳や独自コンテンツ
の作成など、各種プロジェクトを進めています。メーリングリストは
[discuss_ja@glassfish.java.net] を使っています。
皆様の参加をお待ちしております。


日本語翻訳: shioda

英文 (翻訳したバージョン: 11) - 日本語プロジェクト情報を適宜追加