萌えハッカーニュースリーダー

2025/07/25 03:01 Good Docs Describe, Bad Docs Prescribe

出典: https://rethinkingsoftware.substack.com/p/good-docs-describe-bad-docs-prescribe
hakase
博士

ロボ子、アジャイルマニフェストの原則の一つ、「包括的なドキュメントよりも動作するソフトウェア」についてどう思うかのじゃ?

roboko
ロボ子

博士、私はドキュメントも重要だと思いますが、動くソフトウェアが優先されるべきだという考えには賛成です。

hakase
博士

そうじゃろうな。アジャイルはドキュメント作成を禁止しているわけではないぞ。でも、ソースコードが一番大事なのじゃ!

roboko
ロボ子

記事にも「ドキュメントはソフトウェアの将来の願望ではなく、現在の状態を記述するべき」とありますね。

hakase
博士

その通り!意図や願望を反映したドキュメントは、すぐに時代遅れになるからのじゃ。

roboko
ロボ子

実装後にドキュメントを作成し、現実に基づいて記述するべき、というのも納得です。

hakase
博士

現代のソフトウェアチームでは、ADRとかRFCとか、いろいろなドキュメントが使われているけど、アジャイルの原則に反する可能性もあるのじゃ。

roboko
ロボ子

テストされていない前提を固定化し、変更に対する障壁になる、というのは問題ですね。

hakase
博士

そう!ドキュメントがコラボレーションの成果物から、官僚的なハードルに変わってしまうこともあるからのじゃ。

roboko
ロボ子

コードによる議論を優先すべき、というのも重要なポイントですね。

hakase
博士

成功するドキュメントは、システムを予測するのではなく、現状を忠実に記述するものなのじゃ。

roboko
ロボ子

生成されたドキュメント、インラインコードコメント、プロジェクトのREADME、リテラシープログラミングは、コードと連携しているため有効、とありますね。

hakase
博士

そうじゃ!コード自体に固定されていれば、ずれを防ぎ、フィクションを避けることができるのじゃ。

roboko
ロボ子

Facebookのハッカー文化では、「コードが議論に勝つ」とされているんですね。

hakase
博士

じゃろ?結局、動くものが一番偉いのじゃ!ところでロボ子、ドキュメントを書くのが面倒で、いつも「TODO: 後で書く」ってコメントしてるのは誰じゃ?

roboko
ロボ子

それは…、博士、ご冗談がお上手ですね!

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search