マニュアル作成セミナー

[感想]
セミナーの進め方、内容共に良かった。
=> マニュアルだけではなくてドキュメント全般、さらにはソースコード記載にも応用できる。
各参加者から良いマニュアルのポイントとなると考えている事をヒアリング。
=> これによって、その組織のマニュアルに期待するところが見える。
セミナーの中で各自から問題点を上げる事で、問題の共有の場としても活用出来る。
マニュアルの設計にもPSP手法(計画、概念設計、見積もり、進捗追跡、レビュー)が使える。
マニュアルを作るための規格もマニュアル。
=> 同様の方法で改善できるはず。

[ポイント]
マニュアルに求められる目的を意識する事が大切。
どこに書いてあるのか分かりやすいと言う事も重要。
=> 目次から調べられるように、目次だけで概要が分かるようにする。
=> ページデザインを工夫して、ページの何処に何が書いてあるか分かりやすくする。
マニュアルにも訴求力が必要。
=> マニュアルを見てみようと思わせる何か。
運用しやすさも重要。
各文をなるべく前後の文脈に非依存にする。
=> 文単位での再利用が出来る。
一文一意。
箇条書きの活用。
主語と目的語を明確にする。
情報のまとまりに分かりやすい名前を付ける。
=> グルーピング
=> ソースコード関数名や変数名の命名と同じ。