Purpose
- •Create one new ADR document under design/adr.
Steps
- •Decide file path and ADR number
- •Standard path:
design/adr/K4x-ADR-NNN.md - •Use the next unused sequential number for
NNN.
- •Draft the document
- •Always write ADR content in English.
- •Follow structure, status rules, and authoring guidance in GUIDE.md and README.md.
- •Refer to existing ADR files for tone and level of detail.
- •Apply front-matter rules
- •Use the fields defined in GUIDE.md.
- •Set
idas the ADR doc-id and keep it unique across the entire repository. - •Keep
idaligned with the filename stem. - •Add
tasks/plansonly when stable related doc-ids are known; otherwise omit them.
- •Apply references rules
- •Keep a markdown reference list at the end of the file.
- •For links to markdown documents that define front-matter
id:, use that doc-id as the reference label (no.md/.ja.mdin labels). - •Use label-style references in the body (for example,
[K4x-ADR-013]).
- •Finalize
- •Run
make gen-indexafter creating the file to refresh ADR indexes.