満足せる豚。眠たげなポチ。:コードに転嫁できるドキュメントはただのムダ

よしおかさんの「無駄なドキュメントは書くな」から。 ひたすら実装に関するドキュメントをしこしこ書いている人がいるが、好きで書いているわけではなく、書かされているのかもしれないけれど、そーゆー無駄なドキュメントは書くな。時間の無駄である。実装は日々変化する。それに追従する形でドキュメントが更新されるということはない。 まつもとさんも「オブジェクト指向スクリプト言語 Ruby」で「ソースがドキュメントだ。 バグも完全に記述されている」と言っている。 このドキュメントこそが成果物という悪習はウォーターフォール型の開発手法による部分は非常に大きい。なんせ要件定義やら設計やらのPhaseを終わらせようと思ったら、そのPhaseごとの成果物を納品する必要があるのだ。そりゃ、メンテも放置され、コードとの乖離は進む一方になる。しかも、たいていプロジェクトが後々きつくなるのは分かっているから、早いPhase

[keisuke_yamane]

逆説的だけど、ドキュメントを書く理由を上手く書いている。

[hiromark]

ドキュメントは実装の詳細ではなくて、なぜコードをそういった形で書いているのか設計の思想を語るもの。