How-To の書き方 How-To は、特定のタスクを詳細かつ段階的に行うための方法が記載された短文書です。 どんな質問やコメントでも歓迎します。
遠慮なく、 [doc team] （ドキュメントチーム）に問い合わせて下さい。 まずはじめに How-To の書き方 関連項目 基本 How-To テンプレート まずはじめに まず 以下のガイドラインを読んで下さい。:
- あなたが対応する How-To を、どんな人達が読み、何を知りたがっているのか把握して下さい。
- あなたが対応する How-To の話題が、まだ GlassFish のどこにも書かれていないことを確認して下さい。
- タイトルは慎重に決めて下さい。すでにどこかで使用されているような簡潔なキーワード（例： How to Configure a Basic Cluster ）を使うのが理想的です。
- タスクを完了させるための、具体的かつきちんとした手順を、常に書いて下さい。
- 外部のソースやコンテンツは、出典を常に明らかにして下さい。
- あなたの書いた通りに作業できるかどうか、ちゃんと確認して下さい。
- 仕事はきちんと仕上げて、訂正、検討、保存など必要に応じて行って下さい。
- とにかく足を踏み入れ、やってみましょう！ 最初から完璧にやる必要はありません。 なにしろ、これはウィキですから、たとえ正しくなくても簡単に直せるのです。
How-Toの書き方
- GlassFish wiki にログインして下さい。
もし、まだログインも、 GlassFish wiki への参加もしていないようでしたら、login FAQを見て下さい。
\
- Community Docs ページを参照し、 How to Contribute Community Docsの最初の３手順の通りにして下さい。
\
- あなたが対応する How-To のページ名に、接頭辞 Howto_ を付加し（重要！）、新規の wiki ページを作って下さい。 以下は、新規のページを作る具体例です:
- あなたの新規の wiki ページに basic How-To template をコピーして貼り付けて下さい。
\
- そのテンプレートの使い方に従い、必要に応じて、あなたの記事を作成、変更、検討、保存をして下さい。
\
- あなたの How-To ページが完了したら:
この基本ウィキ・テキスト・テンプレートをあなたの How-To ページに使って下さい。
このテンプレートは、この How-To ページにも使われています。
!!!なにをどうするのか
ここでは、あなたの記事を要約し、閲覧者が読むか否かを素早く判断できるようにして下さい。
!!まずはじめに
閲覧者が行わなくてならない作業を、すべて把握して下さい。
また、事例の理解、手順の実施に役立つならば、どんな予備知識でも示して下さい。
!!作業実施
閲覧者がどうやって作業を実施すればいいのか、手順を示して下さい。
可能ならいつでも事例を含めて下さい。説明を添えた良い事例は、効果的な HowTo 記事を書く上で欠かせません。
一つの手順は、７～８手順に分けずに、２～３程度の手順に収めるようにして下さい。
!!関連項目
閲覧者があなたの説明で解決できる様に、役立つ関連情報のリンクを示して下さい。
日本語翻訳: al_cookie 英文 (翻訳したバージョン: 35)
|
