mcaf-adr-writing

Category: 数据与AI | Uploader: managedcode | Downloads: 0 | Version: v1.0（Latest）

Create or update an ADR under `docs/ADR/` for architectural decisions, dependency changes, data-model changes, or cross-cutting policy shifts. Use when the user asks to write, update, or document an ADR, record a design decision, capture architecture trade-offs, or justify a repo-wide technical policy.

Changelog: Source: GitHub https://github.com/managedcode/MCAF

Directory Structure

Current level: skills/mcaf-adr-writing/

📁 references/
- 📄 ADR-FORMATS.md 5.8 KB
- 📄 adr-template.md 5.7 KB
📄 SKILL.md 3.7 KB

SKILL.md

---
name: mcaf-adr-writing
description: "Create or update an ADR under `docs/ADR/` for architectural decisions, dependency changes, data-model changes, or cross-cutting policy shifts. Use when the user asks to write, update, or document an ADR, record a design decision, capture architecture trade-offs, or justify a repo-wide technical policy."
compatibility: "Requires repository write access; produces Markdown ADRs with Mermaid diagrams."
---

# MCAF: ADR Writing

## Trigger On

- a dependency, boundary, platform, contract, or data model is changing
- a design decision has meaningful trade-offs that should be recorded
- a repo-wide engineering policy needs a durable rationale

## Value

- produce a concrete project delta: code, docs, config, tests, CI, or review artifact
- reduce ambiguity through explicit planning, verification, and final validation skills
- leave reusable project context so future tasks are faster and safer

## Do Not Use For

- feature-level behaviour details without an architecture decision
- generic architecture overview content

## Inputs

- `docs/Architecture/Overview.md`
- related feature docs
- the nearest `AGENTS.md`
- current constraints, options, and risks

## Quick Start

1. Read the nearest `AGENTS.md` and confirm scope and constraints.
2. Run this skill's `Workflow` through the `Ralph Loop` until outcomes are acceptable.
3. Return the `Required Result Format` with concrete artifacts and verification evidence.

## Workflow

1. Start from the concrete decision that must be made now.
2. If the ADR is missing, scaffold it from `references/adr-template.md`.
3. Record:
   - context and problem
   - chosen decision
   - alternatives considered
   - trade-offs and consequences
   - implementation plan
4. Add diagrams only when they remove ambiguity.
5. Link the ADR to affected feature docs and `docs/Architecture/Overview.md`.

## Deliver

- `docs/ADR/ADR-XXXX-short-title.md`
- linked updates to architecture docs when the decision changes boundaries

## Validate

- the decision and rejected alternatives are explicit
- trade-offs are concrete, not hand-wavy
- implementation impact is clear
- a future engineer can understand why this path was chosen

## Ralph Loop

Use the Ralph Loop for every task, including docs, architecture, testing, and tooling work.

1. Plan first (mandatory):
   - analyze current state
   - define target outcome, constraints, and risks
   - write a detailed execution plan
   - list final validation skills to run at the end, with order and reason
2. Execute one planned step and produce a concrete delta.
3. Review the result and capture findings with actionable next fixes.
4. Apply fixes in small batches and rerun the relevant checks or review steps.
5. Update the plan after each iteration.
6. Repeat until outcomes are acceptable or only explicit exceptions remain.
7. If a dependency is missing, bootstrap it or return `status: not_applicable` with explicit reason and fallback path.

### Required Result Format

- `status`: `complete` | `clean` | `improved` | `configured` | `not_applicable` | `blocked`
- `plan`: concise plan and current iteration step
- `actions_taken`: concrete changes made
- `validation_skills`: final skills run, or skipped with reasons
- `verification`: commands, checks, or review evidence summary
- `remaining`: top unresolved items or `none`

For setup-only requests with no execution, return `status: configured` and exact next commands.

## Load References

- start with `references/adr-template.md`
- use `references/ADR-FORMATS.md` only for numbering or formatting conventions

## Example Requests

- "Write an ADR for moving to event-driven notifications."
- "Document why we are adding PostgreSQL instead of keeping SQLite."
- "Capture the policy decision behind local project AGENTS files."

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

mcaf-adr-writing

Directory Structure

SKILL.md

Report

Notice