2007.02.10

あるとうれしいドキュメント

ひとつのシステムをつくるときには沢山のドキュメントがうまれます。もちろん文章だけでなく、
図などもありますが今回はひっくるめてドキュメント、または資料と呼ばせてもらいます。

ドキュメントは議事録など一部のものを除き、システムの各工程の成果物としてソフトウェアと
共に納品されることが多いです。しかし、せっかく作成したドキュメントですが個人的に活用する
機会はあまり無いような気がします。開発者の視点でしかありませんがシステムのことをちょっと
調べるにしてもプログラムのソースを読んでしまうんですね。理由は見るだけで何でも分かる
ドキュメントをつくれない自分の力量不足でもあるのですが、ソースのほうが正確だし、細かいことは
ソースを読まなけらばわからないというところにもあります。

そういう理由から、規模にもよりますが自分が携わっていないシステムに携わることがあっても
大雑把な資料やそのシステム独特な処理に関しての資料とソースがあればなんとかなるのでは
ないかと思っています(それは甘すぎるかな)。
しかしながら今まで見たことは無いものでこれだけはあるとうれしいと思っているものがあります。
それはシステム設計者の設計思想などが描かれているような資料です。
私はシステムには設計者の意向や思想が色濃くでると考えていて、なぜこのようなつくりなのか?
というような類の疑問はソースを読んでも絶対に理解できないものだからです。胸の中にモヤモヤ
したものを抱えながらシステムをつくるのは気持ち悪いし、偉大な先駆者の知恵を理解できない
のは非常に悔しい。

なんていいながら私もそのようなものはつくったことは無いのですがね。

話は変わりますが、納品するドキュメントも日本版SOX法などの関係で今後は今以上に
高品質なものが求められるようになるかもしれません。ドキュメントの工数もバカにならない
のでしっかり見積もりするようにしないと痛い目をみるかもしれませんね。

photo
furugoori