agf-writing-adr

Solid

Use when tech-lead is about to record an architecture decision (new tech stack member, deviation from baseline, deployment / observability / auth scheme choice). Provides ADR structure, version-audit appendix format, and "what NOT to ADR" guidance. Replaces ad-hoc copy from ADR-000.

AI & Automation 423 stars 11 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
87
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Writing an ADR (Architecture Decision Record) Use this skill when: - A new technology / framework / vendor is being added to the stack (not already covered by ADR-000) - An existing baseline is being **deviated from** (e.g. swapping Postgres → SQLite for a specific service) - A cross-cutting decision needs explicit record (auth scheme, deployment shape, observability stack, LLM caching policy) - code-reviewer escalates a "this needs ADR" finding **Do NOT write an ADR for**: - Routine library version bumps (lockfile is enough) - Internal refactors that don't change external contract or stack - Bug fixes - Anything one team would forget within a month If unsure → write it. ADR cost is low; the "why" memory is what disappears. ## File path & numbering `docs/adr/NNN-[slug-kebab-case].md` — sequential, zero-padded 3 digits. Examples: - `001-jwt-vs-session-auth.md` - `002-llm-caching-policy.md` - `003-deploy-target-fly-io.md` ADR-000 is reserved for the system architecture baseline. Never reuse a number; if abandoned, mark `Status: Superseded by ADR-NNN`. ## Status lifecycle `Proposed` → `Accepted` → (later) `Superseded by ADR-NNN` / `Deprecated`. Once `Accepted`, **do not edit decisions**; supersede with a new ADR. Allowed in-place edits on Accepted ADRs: - Backfill `## 版本与查证` rows when a deferred row resolves - Typos and broken links Anything else → new ADR. ## Required sections ```markdown # ADR-NNN: [Title] - 状态:Proposed / Accepted / Superseded by ADR-NNN / Depr...

Details

Author
pcliangx
Repository
pcliangx/AppGenesisForge
Created
3 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category