logo hsb.horse

Architecture Decision Record

ADRの運用方針

ファイル命名、言語運用、掲載スキーマを整理する。

採用 #docs #process

ADRの運用方針

決定

  • docs/ADR/YYYY-MM-DD-NNN-<slug>.<lang>.md を採用する。
  • langja / en を基本とし、将来追加を許容する。
  • 1件の意思決定につき言語ごとに1ファイルを置く。

背景

時系列に並べやすく、多言語の対応関係も分かりやすい命名が必要だった。

理由

  • 日付と連番を含めることで、時系列と通し番号の両方が明確になる。
  • .<lang> で言語を明示できる。
  • slug を短く保ち、URLや一覧で読みやすい。

影響

新しいADRを追加する際は、同じ日付と連番で jaen の2ファイルを作る。