理系のための文書作成術(1) ―― 開発文書を分かりやすく記述する

ソフトウェアやハードウェアなどの開発作業には，仕様書や設計書などの文書（ドキュメント）を読んだり書いたりすることが欠かせません．通常，開発文書は，読み手が理解しやすいように，正確で明快であることが求められます．さらに，開発文書としての内容が必要十分であることも求められます．それは，読み手が，開発文書の内容を理解するだけでなく，理解した情報を次に続く開発作業につなげなければならないからです．読み手にとって分かりにくい開発文書は，読み手の理解を妨げ，さらには開発作業の進み具合や作業そのものの成否にも影響を及ぼします． 本連載では，ソフトウェア開発を例にして，仕様書や設計書に散見される分かりにくい記述例を紹介しながら，次の論点を考察していきます． どんな文書が開発を妨げるのか 分かりやすい開発文書を書くにはどうしたらよいのか 文書作成をどのように開発業務に組み入れていけば，品質と生産性が上がるの

[prisira]

具体的な問題改善例などが載っていてとても参考になる。連載「理系のための文書作成術」全体的に良い記事。

[raitu]

1.曖昧に読点で単語を列挙しないこと 2.「いつ」を「状態」で説明せずイベントタイミングで説明すること 3.「点灯処理」→「点灯する」のほうが分かりやすくシンプル。文章に推測余地をなくすこと。