adr-writer

Architecture Decision Records in Markdown require a standardized structure enforcing file naming like ADR-{NNN}_{slug}.md, complete front matter schemas, and Obsidian wikilinks to ensure traceability and proper indexing within your knowledge base.

An Architecture Decision Record (ADR) is a formal log capturing architectural decisions. You should document an ADR whenever you make a significant architectural choice, recording the context, decision, alternatives, and risks to maintain project governance and traceability.

Yes, this ADR generation approach works with Obsidian by enforcing Obsidian-style wikilinks for internal references and requiring a complete front matter schema. This integration ensures your decision records are fully indexed and navigable inside Obsidian.

To update existing ADRs while maintaining conventions, you reference the specific code like ADR-001. The system applies updates while preserving the required ADR-{NNN}_{slug}.md file naming format and validating the complete front matter schema.

Yes, you can save an Architecture Decision Record as a draft before publishing. The system supports both draft and published states in the front matter, allowing you to iteratively build context, decisions, and risks before final governance approval.

Malformed or unsafe ADR contents are actively rejected during markdown generation. The system guards against unsafe inputs by validating the front matter schema and enforcing structural consistency, ensuring your architecture documentation remains secure and compliant.