adr-writer

You can document software architecture decisions by generating Architecture Decision Records (ADRs) that provide structured templates for context, decisions, consequences, and alternatives. This enforces documentation discipline for design choices.

An Architecture Decision Record should include the problem context, the chosen decision, rationale, trade-offs or consequences, alternatives considered, and references. This ensures traceability and clarity in software architecture.

To create a new ADR for database technology selection, use the creation command with a title. You can then add context, outline the chosen solution like PostgreSQL, state reasons, and document alternatives like MySQL.

The best way to enforce spec-first development is by managing ADRs through CLI commands for creating and updating records. This ensures documentation discipline and traceability for significant design decisions.

Yes, you can update existing Architecture Decision Records by using specific CLI commands to add details, context, or references. This facilitates ongoing governance and maintains clarity as software architecture evolves.

You need to create an Architecture Decision Record when a team makes significant design decisions, such as adopting a new technology. It outlines the problem, chosen solution, reasons, trade-offs, and alternatives to ensure maintainability.