開発ドキュメントを何で作成するか？

開発ドキュメントの作成にあたって

2008年の2月の特集「楽々デブドックを書こう！」 の火曜日は「ドキュメント作成の技」と題して、開発ドキュメント（デブドック）を作成する際に役立つワザを解説していく。取り上げるツールは 「Excel」である。第1回の今回はなぜExcelを取り上げるのかについて解説していく。また先月の読者アンケートから開発ドキュメントの作成に利用 しているツールを集計した結果も合わせて紹介していく。

開発ドキュメントと一口にいっても、開発の工程によってさまざまなものがある。システム開発に当たっては、ユーザ企業からの要望に対して、 システム構成などをまとめた文書や、開発を進める上で必要となる仕様書や設計書、そして成果物をテストする際にもテストの内容に合わせたドキュメントが必 要だ。

これらの開発ドキュメントがないと、どのように開発を進めていいかわからなくなる。ソフトウェア開発の規模が大きくなるにつれて、開発に携 わるすべての人間に対して、Face to Faceですべてを伝え、理解してもらうことは難しい。これらのドキュメントは、その伝達手段の1つといえる。

近年ではソフトウェアの品質が注目されつつある。完成した成果物が求められる製品であるかを判断するには、求められている要件がどのような ものか、どのような機能かを明確にしたドキュメントが必要だ。実際に完成したはよいが、いざ納品の段階になって求められたものと違い、再び開発し直すなど の例も実際にある。その時にドキュメントがあることで、何が間違っていたのか、またどの段階でミスが発生したのかも確認できる。責任の所在も明らかにする ことができるだろう。

また、ウォーターフォールやアジャイルなど、開発手法によっても必要なドキュメントや書き方が変化する。開発手法によって、工程の考え方や 作業の進め方が変化するからだ（開発手法の違いによるドキュメント作成については、木曜日「手法別開発ドキュメントの書き方」で解説する）。

図1：開発ドキュメントに使わるツールの例

開発ドキュメントの作成に何をつかうか

開発ドキュメントの作成にはさまざまなものが利用されている。そのドキュメントの内容にもよるが一般的にはWordやExcelが用いられることが多い。また、ウォーターフォールにおけるシーケンス図などの作成においては、専用のツールが用いられている。

では実際にどのようなものが使われているのかについて、読者アンケートの結果から見ていこう。