詳細設計書

 

詳細設計書ってよくわからない

http://d.hatena.ne.jp/hyoshiok/20140310/p1

 

いや、本当によくわからないんです。

なんで、いまだにこんなことに貴重な工数を費やさないといけないのか。

 

自分もかつてコードの一行一行に対応するようなEXCEL詳細設計書を作らされたことがありますが、なんともやりきれない気持ちになりました。

「ドキュメントをおろそかにしたプロジェクトが成功したためしはない」とかおっしゃる方がリーダだったのですが、目的も何も考えずにドキュメントをひたすら書かせた結果、だれも必要としない大量のEXCELが出来上がりました。

特にひどい記述だと、「○○オブジェクトをnewして、そこに××を格納する」というものもありました。

とりあえず処理を詳細に記述することが目的になっていて、

実装者以外がこれを読んでも意味分からんでしょというような感じでした。

もちろん、その処理のつまるところの目的なぞ記述されていません。

ただ単に処理を並べただけです。

最後には納品物として徹夜で印刷してファイルに閉じて客先(エンドユーザ)に持っていったらしいですが、今後誰もこの資料に目を通すことはないでしょう。

プログラマが読んでも分からないし、プログラマならコードを読んだほうが早いですから。

 

やっぱり、だれのため、何のためのドキュメントなのかということについて、ちゃんと考える必要がありますね。

 

「コードは暗黙知だから、形式知化するためにドキュメントを作らないといかん」みたいな記述をなにかの本で見たような気がします。

コードは所詮処理の塊ですから、意味するところ(What)を伝えるためには、

なんらかの情報を補完してやらないといけないってことです。

こういう類のドキュメントなら必要だと思います。

それをどういう形で記述するのか、いろいろな方法があると思いますが。

 

# コードで表現できるならコードでもいいのでは? と言っても納得してくれない人も多いでしょうねぇ・・・。