メインコンテンツへスキップ
< すべてのトピックに戻る

ドキュメントが古くならないようにするには?

「いつ、誰がドキュメントを更新するか」のタイミングと責任者を明確に決め、リリース時などの節目で必ず見直す運用(仕組み)を作ります。

仕様変更のたびにコードだけを直し、ドキュメントの更新をサボっていると、数ヶ月後には「誰も信用しない嘘が書かれたゴミ文書」と化し、読むだけ時間の無駄になってしまうからです。

大きな機能追加のPull Requestを出す際の「完了条件(DoD)」の中に、「関連する仕様書やREADMEを最新化する」というチェック項目を含め、コードとドキュメントの更新をワンセットで強制します。

タグ:
目次

9周年キャンペーン実施中 早い申込みほど受講料がお得に