ほげにっき

hogedigoの日記

Document Programming

冗長なドキュメントは一度作ったが最後、恒久的にメンテナンスコストが発生する。メンテナンスしなければすぐに陳腐化する。でもお客さんは欲しがる。だったら生成しよう。


ソースコードと、ソースドキュメント(シンプルに仕様をまとめたモノ)を元に、付加的なドキュメントを生成する。


プロジェクト毎に必要なフォーマットは異なるだろうけど、そのつど生成する仕組みをカスタマイズする。その手間を払っても、ドキュメントメンテナンスコストがなくなるメリットは大きい。


あとは生成する仕組み・パターンを洗練させていければ。