TestFormat - yottchan @ Wiki

タイトル（わかりやすく手短に）

↑書式＝大見出し。文頭に”*”をつける。

文書管理番号：OW-00001-01B
↑ページタイトルになります。ページリンクにも使用。

補足）文書管理番号について

 O=OS S=SWパッケージ H=ハードウェア

↑書式＝枠囲み。文頭に”半角スペース”をつける。
　おもに、コマンド入力や、標準出力を書くときに。

　例えば、

文書管理番号	例題
第1パート	OW=Windows系　OS=Solaris系　OL=Linux系など
第2パート	-nnnn=文書通番
第3パート	-nn＝バージョン（Bが付くと暫定修正版）

↑書式＝テーブル。項目を”|(パイプ）”で区切っていく。これを行分繰り返して書く。

---

現象（問題の概要）

↑書式＝中見出し。文頭に”**”をつける。項目名は統一させる。この項目に沿って書いていく。
　どのような問題で、どのような現象がはっせいするのか

該当するバージョン（H/W構成、環境）

↑書式＝中見出し。項目名は統一させる。この項目に沿って書いていく。
　Windowsなら、

• Windows2000　Server　SP1（のように）
• Linuxなら、ディストリビューション Ver　Kernelバージョン

↑書式＝リスト。文頭に”-”をつける。箇条書きする場合。

　問題が発生した環境構成、どのような操作をしたとき　など
　＜必要であれば図を挿入＞

---

↑書式＝横線。この位置も統一させる。

原因

↑書式＝中見出し。項目名は統一させる。この項目に沿って書いていく。
　どうして問題現象がおこるのかをできるだけ詳細に。

対処方法（解決策）

↑書式＝中見出し。項目名は統一させる。この項目に沿って書いていく。
　どうしたら、恒久的に原因をつぶすことができるか。
　もしくは、暫定的に、簡易的に回避できるか

---

関連情報（他文書番号リンク）

↑書式＝中見出し。項目名は統一させる。この項目に沿って書いていく。
　関連する文書番号があれば、そこへのリンク

---

記事内容や修正作業コメント

↑書式＝コメント

---

キーワード
　この文書をキーワード検索する際の検索キー