create-adr

To create an Architectural Decision Record, you provide a title, context, rationale, alternatives, and stakeholders. The system validates these inputs and writes a versioned, template-based ADR file to preserve context for significant design decisions.

An ADR for project governance should include context, the accepted decision, consequences, rejected alternatives, and stakeholders. This structured documentation ensures future maintainers understand why specific technology choices were made and can avoid re-litigating them.

ADR files are organized under the docs/adr directory. The system automatically determines the next sequence number from existing files and writes a correctly named markdown file following the adr-NNNN-title-slug.md format for consistent versioning.

Yes, you can record accepted, rejected, or superseded options during software architecture decision-making. Capturing these alternatives ensures future teams understand the full scope of evaluated choices and the reasoning behind the final decision.

The best way to maintain context is generating a versioned ADR file with required metadata. This captures key design choices, validates essential inputs before writing, and produces a standard template for long-term reference in software engineering projects.

No, you do not need to manually format the markdown file. The system applies a standard template for long-term reference, automatically handling the file naming sequence and validating that all essential inputs are provided before writing the document.