netail.net
自作フリーソフトや，ゲームに関する雑記を公開してます．
日記はソフトウェア工学の論文ネタが中心です．
最近のお知らせ (古いものはこちら)
2007-05-15 [長年日記] ▲
_ [論文] 開発者はドキュメントは読んでない ▲
LaToza, T. D., Venolia, G. and DeLine, R.: Maintaining Mental Models: A Study of Developer Work Habits. Proceedings of the 28th International Conference on Software Engineering (ICSE 2006), pp.492-501, Shanghai, China, May 2006. [ACM site]
開発者の作業時間の割合を調査した論文で，納期が近づくにつれて新機能を書く時間よりバグフィクスにかかる時間のほうが増えているとか，作業に割り込みがかかると，元の作業に復帰するまでには時間がかかるといった知見を得ています．
プログラム理解に使っている時間とコードを書いてる時間には負の相関があり，開発者は，自分が書いたコードについては十分な知識を持っているからプログラム理解には時間を消費してはいないようだとしています．
設計ドキュメントはいちおう書くものの，書いたものを読み返すことはまれであり，実際には自分が相手にしているコードを読んで知識を再発見している（そしてドキュメントは陳腐化していく）としています．
D. Spinellis の Code Quality (Addison-Wesley)の 7.2 Analyzability でも「コメントはアップデートするべきだが，他人がそうしてることを期待してはいけない」と言及されていたりするのですが，ドキュメントをきちんと更新しないから読まないのか，読まれないからどうせ更新しないのか，因果関係は謎です．ただ，こういうのを読んでると，「ソースがドキュメントだ」という発言にはそれなりに説得力がある気がしてきます．
終盤は時間がなくなってドキュメント修正が追いつかなくなっていくんですよね。
そういう意味では「更新されてないから読まない」です。
そうすると「ソースを見たほうが正確」ってなっちゃいます。
昔はドキュメントが皆無であったためソースを読むしかなかったようですが、いまはわりと「ドキュメント読め」という事も多いです。
わりとちゃんとアップデートしてます。
＃GUIがあると更新にかなりの労力を使うので専任者をつけたりします。