「やらない」を残す決定ログの書き方
「やらない」を残す決定ログの書き方
何かアイデアを思いついたら issue として起票することになります。 しかし、issue 上あるいは頭の中や他の人との議論の中で、「そのアイデアは採択しない」という判断をした時、どこにも情報が残らないため、また同じ議論を始めてしまう可能性があります。
今回は、一度した議論や結論を決定ログとして残す方法について考えます。
議事の残し方
/ をホームとして維持する判断を後から追えるよう、決定ログを追加しましょう。docs/decisions/2024-xx-home-route.md のような新規ファイルや既存の docs/DECISIONS.md に追記する形が手軽です。 内容は日付・背景（/home リダイレクト案との比較など）・採用した方針・再検討の条件を簡潔にまとめるのがおすすめです。 Git にはログファイルの追加／更新だけをコミットし、メッセージを docs: ホームルートの判断を記録 といった形にすれば、履歴で議論の意図がすぐ分かります。 それはみんなやってることなの？ 他に良い方法ないですか？
よくあるやり方ではありますが、絶対の正解ではないです。いくつか他の選択肢もあります。
Issue/PR にまとめる チームが GitHub Issue やチケットを運用しているなら、そこで議論→クローズの形で履歴を残す方法も一般的です。後で「なぜこうなった？」を調べるときにスレッドが読み返しやすい利点があります。
リポジトリ内の決定ログ（ADR/DECISIONS） 質問で挙げたドキュメント化の手法は、Architecture Decision Record (ADR) という名前でよく用いられています。議論の要約と最終判断がコンパクトにまとまるので、チーム全体が「今の方針」と「再検討タイミング」を共有しやすいです。
開発者向け Wiki / Notion リポジトリ外に情報基盤がある場合は、そこへ議事録を残す方法もあります。構造化されたページに追記することで、類似エントリを並べて比較しやすいというメリットがあります。
コミットメッセージやコードコメントで文脈を残す 今回の判断が特定のファイルの実装に直結しているなら、該当コミットやコードコメントに「/ を直接ホーム表示にしている理由」を一言添えるのも有効です。軽量で、コードを読む人がその場で意図を把握できます。
