/note/tech

プロダクト開発を成功に導くドキュメントって何だ?iwashiさんに学ぶ“神ドキュメント”の作り方

優れたドキュメントには、大きく二つの特徴があります。

一つは、ユーザー(ドキュメントを使う人)の課題解決につながる内容であることです。

(中略)

また、優れたドキュメントの二つ目の特徴は、「生きている」ということ。つまり、常に最新の状態が保たれたドキュメントであるということです。

世の中には「コードを見れば全部分わかるでしょ」といったストロングスタイルな開発者も存在しますが、今回翻訳した書籍の中ではむしろ失敗パターンとして挙げられています。名著である『A Philosophy of Software Design』の中では、そうした考え方は「神話」だと一刀両断されています。