create-adr

To document an architecture decision record, you can generate a MADR-style template that structures the decision, context, drivers, options, and consequences. This ensures your architectural choices are formalized and ready for a centralized version control directory.

Structuring options analysis in an ADR involves detailing the considered options, their consequences, and the drivers behind the choice. Interactive prompts guide you through this process to ensure completeness when capturing the architecture decision.

Yes, you can generate architecture decision records in MADR, Nygard, and Y-Statement formats. This allows your engineering team to choose the documentation style that best fits your existing workflow and centralized ADR directory.

You can link a new architecture decision record to related RFCs, tickets, or existing ADRs. This is supported natively during the generation process to ensure centralized documentation maintains proper traceability and context.

An architecture decision record tool assigns sequential numbers by scanning the existing centralized ADR directory. It automatically detects the latest decision record and increments the number for your new documentation file.

You should use an ADR template when making a significant architectural choice that needs to be preserved for future engineers. It formalizes the context, drivers, and consequences of the decision within your version control system.