adr-creator

An Architecture Decision Record (ADR) documents architecturally significant decisions to record, reference, and supersede choices across a project's lifecycle. You need an ADR when teams must capture forces, context, and consequences of a design choice.

To create an Architecture Decision Record, describe the decision you want recorded. The workflow detects your ADR directory, gathers forces, captures active-voice decisions, checks for superseded records, and logs consequences to generate the file.

You do not need adr-tools installed to generate ADR files. The workflow checks for adr-tools and uses it for automated file creation if available, otherwise falling back to a manual template to document the architecture decision.

To supersede an old architecture decision, the ADR workflow prompts you during creation to check for existing records. It updates the status of previous ADRs to superseded and links them to the new architecture decision record.

The best way to document context and consequences is using a structured ADR format that enforces neutral context and active-voice decisions. This ensures the architectural forces and impacts are recorded clearly without subjective bias.

Yes, you can document architecture decisions for an existing project. The workflow detects the ADR directory within your project structure and records the new decision alongside existing files, maintaining consistent referencing and superseding.