ドキュメントについて

質問

ＳＥ（システムエンジニア）系の仕事に携わっている方で、ドキュメントの作成って重要だと思うのですが上手いドキュメントを作成するために、何か参考になるサイトや書籍などありますか？？
※上手いという表現は微妙ですね、分かりやすいとか綺麗という表現が　正しいのでしょうか　

単にドキュメントといっても例えば設計書類やテスト項目書、仕様書、進捗管理などいろいろあると思います。
作業を行ううえで上手いドキュメント作りって非常に重要だと思うのですがドキュメント作成が苦手で困っています。
参考になる（勉強になる）サイトや書籍があれば拝見して勉強したいと思っております。
ドキュメント作りが上手い人って尊敬するし憧れます。

変な質問ですが、真剣に悩んでいます。
どうか宜しくお願い致します。

回答No.2

buriburi3 · ベストアンサー

普通のマニュアルの書き方は勉強していますか？
ＳＥの場合には通常のマニュアルの書き方に加えてテクニカルライティングと工業英検を合わせて勉強すると良いです。
「ユーザ・読み手の心をつかむマニュアルの書き方」
出版社: 共立出版 (1987/08)
ISBN-10: 4320008588
ISBN-13: 978-4320008588

「ザ・テクニカルライティング」
出版社: 共立出版 (1993/05)
ISBN-10: 4320008847
ISBN-13: 978-4320008847

お礼

回答ありがとうございます。
紹介して頂いた書籍は非常に興味深いです。
本日仕事の帰りに近場の書店へ探しにいきましたが2冊とも現在品切れ状態でした。
休日にでも大きい書店へ探しにいこうかと思います。
ありがとうございました。

回答No.1

maccha_neko

基本的には、ドキュメントはトップダウン的にまず全体像を提示して、そこから各項目にブレークダウンしていくというスタイルで書くと綺麗におさまりやすいです。この「全体像の提示」っていうのが意外と難しいんですけどね。
試験項目なども同じですね。まずは何を試験したいのかをはっきりさせて、それに対してどういうことを行い、どのくらいまでカバーできているか等を考えていくとまとめやすいでしょう。

お礼

回答ありがとうございます。
ブレークダウンですかぁ　なるほどぉ
今後は意識しながら作業を行っていきたいと思います。
ありがとうございました。