ドキュメントの見栄えについて勉強する方法

質問

日々、IT系の設計書や手順書やマニュアルなどの作成をしています。そこで見栄えのよいドキュメントの書き方の勉強をする上でお勧めの本を知りたいです。ご存知の方がいらっしゃいましたら教えていただけるとありがたいです。よろしくお願いいたします。

回答No.1

noname#245936 · ベストアンサー

見栄えの良いDocumentですか。
私も手段を模索したことがあります。
が、私のいたった結論は、人のマニュアルを真似ることでして。

ソフトウェア手順書なら、
・超図解シリーズ、カンタンシリーズの書籍。
・優良メーカーマニュアル
　Epsonさん、メルコさんあたりのH/Wメーカーさん。
この辺は勉強になると思います。

ちなみに、設計書のほうですが。
こちらは結構難しいですね。

UML や何や、ソフトウェアを修飾するDocumentはいくら書いても
キリがありませんし、ソフトの変化に同期をとるのが難しいです。
エンドユーザが多ければ書く意味も違ってきますが、一般の
1000名以下のユーザしか存在しないソフトの場合は、あまり時間を
とってもコスト的に元が取れないはずです。

高級言語で作成している場合、ソースコード自身が動きそのもの
ですので、＋Readme程度で概要をつかむ程度までしか残さない。
また、お客様へのファーストアプローチの部分は詳細まで説明を
あえてしない概要ワークフローを３・４枚に抑える。
これが最適解のような気がします。

あとは、Wordなどで概要をこさえ、表紙、裏表紙、段落分け済みの
テンプレートをデザインに強い方に加工していただき、統一感を
だせばそこそこ見栄えはいいような気がします。

多すぎる文書はだれも読んでくれませんので。

お礼

人のマニュアルを真似る
概要ワークフローに抑える（ドキュメントとソースの同期をとることが難しいため）
なるほどと思いました。ありがとうございます。