mcaf-adr-writing

Create standardized Architecture Decision Records with templates and Mermaid diagrams.

20|Updated Feb 1, 2026
One-click install
npx skills add https://github.com/Zendevve/opentweak --skill mcaf-adr-writing-zendevve
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mcaf-adr-writing
Source: https://github.com/Zendevve/opentweak/tree/main/.codex/skills/mcaf-adr-writing
Command: npx skills add https://github.com/Zendevve/opentweak --skill mcaf-adr-writing-zendevve

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Architecture decisions are hard to track without a consistent, testable record. This Skill provides a structured approach to create and update Architecture Decision Records (ADRs) using repository templates, ensuring decisions are documented with context, diagrams, and verifiable outcomes.

Core Features & Use Cases

  • Template-driven ADR creation using docs/templates/ADR-Template.md
  • Mermaid diagram support to illustrate boundaries and interactions
  • Explicit verification and invariants to ensure decisions are testable

Quick Start

Create an ADR from ADR-Template.md, fill in context, decision, diagram, alternatives, and consequences, then commit to docs/ADR.

Frequently Asked Questions about mcaf-adr-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an Architecture Decision Record that includes verification steps?

To write an Architecture Decision Record with verification, use a standardized template to define context, alternatives, consequences, and explicit invariants. This ensures architectural choices are self-contained and testable against repository rules.

What is the best way to document software architecture boundaries and dependencies?

Documenting software architecture boundaries and dependencies is best achieved by creating Architecture Decision Records augmented with Mermaid diagrams, which visually illustrate interactions while explicitly capturing the decision context and consequences.

How do I add Mermaid diagrams to an ADR template?

You add Mermaid diagrams to an ADR by applying template-driven documentation that integrates Mermaid syntax to illustrate boundaries and interactions. This standardizes architectural records while making complex data models visually self-contained.

When should I create an Architecture Decision Record for cross-cutting patterns?

You should create an Architecture Decision Record when changes affect architecture, boundaries, dependencies, data models, or cross-cutting patterns. This ensures significant structural shifts are documented with testable verification steps.

Does this ADR approach work without external dependencies?

Yes, this ADR approach works without external dependencies because it relies on standard repository templates and Mermaid diagrams. It enforces executable invariants and required tests validated directly against your repository rules.