コード書きよりドキュメント作り

昔、最初に入った会社で先輩にあたる人(いや、向こうは先輩後輩という関係とは思っていなかっただろう)が、コードを書くよりもドキュメント作成に時間取られてかなわない、とぼやいていたことを思い出す。

実際、自分でしょぼいコードを書いて、そのドキュメントを作っていると実感する。確かに時間取られるなあと。

BASICでコードを書いていた時代は、ウォーターフォールのように最初から最後まで読んでいけば内容は分かる。だけどオブジェクト指向の時代になると、コードの中からぽつぽつコメントを拾い出していてもよく分からない。ましてRailsのように、いくつもの設定ファイルやコードが組み合わさって動いているようなものになると、コード中のコメントだけでは絶対に不十分だ。

というわけでドキュメントを書く。
下手するとコードそのものよりもドキュメントの方が長くなるぞ。

ま、書いているうちに設計ミスに気づいたりもするのだが。