目次 価値のあるドキュメントの条件 ドキュメンテーションの置き場所 参考 参考書籍 価値のあるドキュメントの条件 価値のあるドキュメントの条件は以下の5つ。 有益である（コードの動きの説明ではなく、理由が書いてある） 書きやすい 見つけやすい 読みやすい 信頼できる ドキュメンテーションの置き場所 ドキュメンテーションを可能な限りソースコードに近い場所に置く。 具体的にはソースコードそのものに詰め込むか、ソースコードと同じGitリポジトリに入れる。 参考 参考書籍 書籍『レガシーソフトウェア改善ガイド』 上へ戻る