====== 手順書の書き方 ====== ===== 操作手順書 ===== [[http://www.atmarkit.co.jp/ait/articles/1010/19/news126.html|マニュアル執筆が怖くなくなる、12の執筆ポイント]] ==== 操作マニュアルを記述する ==== - 読み手に分かりやすい流れを考える - 操作手順は「画面→説明文」で書く - 操作結果は「説明文→画面」で書く - 操作手順と結果説明は、明確に分離して記述する - すべての画面をきちんと記述する - 主語はユーザー? システム? 主語の表現を区別する - 時間軸に沿って業務の流れを記述する - 業務で行う作業を漏れなく記述する - 操作マニュアルと正確に関連付ける - ユーザー側独特の用語・表現に注意する ==== 障害対応マニュアルを記述する ==== - ユーザーが障害状況を判断できる表現にする - 自力解決できない障害も書いておく ==== その他 ==== * [[http://www.atmarkit.co.jp/ait/articles/1009/14/news106.html|「目次」の良し悪しが、すべてのマニュアルの良し悪しを決める]] * [[http://www2s.biglobe.ne.jp/~kobayasi/manual/2011-new/00-renewal-index-0.htm|マニュアル(Manual)講座]] * [[it技術:システム開発:日本語表記ルール|]]