mcaf-adr-writing
Create or update an ADR (Architecture Decision Record) under `docs/ADR/` using `docs/templates/ADR-Template.md`: context, decision, alternatives, consequences, rollout, and verification. Use when chan
Files3
View on GitHubSKILL.mdskills/mcaf-adr-writing/SKILL.md
GitHubMCAF: ADR Writing
Read root/local AGENTS.md, the affected architecture, feature requirements, contracts, and existing ADR conventions.
Workflow
- Define the concrete decision, current constraints, alternatives, trade-offs, and affected
REQ-*/AC-*or cross-cutting operational obligation. - Obtain user approval before implementing a material architecture, serializer/serialization, contract, data, security, dependency, or deployment change. Prior approval for that exact decision remains valid; a proposed ADR is not approval.
- Apply
MCAF-ARCH-001: keep solution artifacts in one repository and preserve canonical slices. Existing deviations need a migration owner, target, verification, and removal date. - Apply
MCAF-REQ-001: define ordered implementation stages, exact file/slice ownership, dependencies, preserved/changed contracts, migration/rollout/rollback, tests, pass conditions, and evidence. - For delegated implementation, record
MCAF-AI-001roles, disjoint writes, native status/wait, explicit completion states, escalation, and join gates. - Link related feature docs and the architecture map. Include a rendered Mermaid diagram for the decision's boundaries or interactions.
- Use
Proposeduntil approved,Acceptedwhile implementation is pending, andImplementedonly when required code, migrations, tests, docs, and verification evidence exist.
Deliver docs/ADR/ADR-XXXX-short-title.md using the repo's numbering and naming convention. Review the whole record for real values, traceability, and status accuracy.
References
- For scaffolding: ADR template.
- When adapting a compact or options-matrix format: format guidance.
- For feature/decision obligations: requirements traceability.