A tool for generating lightweight Architecture Decision Records (ADRs) for small teams, focusing on context, decision, consequences, and status.

Stars

25

7-day growth

No data

Forks

17

Open issues

0

License

MIT

Last updated

2026-07-29

AI repository intelligence
FR-AI / ANALYSIS

Why it is worth attention

It simplifies ADR creation with configurable options and targets small teams that often neglect architecture documentation, helping them maintain durable records.

Who it is for

  • small software teams
  • software architects
  • developers
  • tech leads

Use cases

  • recording stack/library/protocol decisions
  • documenting cross-team rationale for why X was chosen
  • superseding old decisions with new ones
  • creating lightweight RFC-lite ADRs

Strengths

  • concise format that small teams actually maintain
  • configurable options (language, format, status, id style, depth)
  • focuses on consequences and status for decision tracking
  • MIT licensed and easy to install via npx

Considerations

  • limited to small-team contexts and may not scale to enterprise-level RFCs
  • requires npx installation and external skill management tooling
  • does not cover full multi-option RFCs (recommends separate rfc-outline skill)

README quick start

ADR Writer

Write lightweight Architecture Decision Records for small teams: context → decision → consequences → status.

中文简介: 小型团队 ADR(背景→决策→后果→状态)。 — 详见 README.zh.md.

What this skill does

  • You produce short, durable ADRs small teams actually maintain
  • Scope: Small-team software architecture & tooling choices
  • Deliverable: One ADR page with status + consequences
  • Triggers: ADR, architecture decision record, tech decision log, RFC-lite ADR.

Install

After this package is on GitHub:

npx skills add / --skill adr-writer

Local monorepo: point your agent at skills/adr-writer/ (this folder).

Options

OptionValuesDefault
langen · zh · bilingualen
formatmadr · nygard · onepagernygard
statusproposed · accepted · deprecated · supersededproposed
id_stylesequential · date · nonesequential
depthlite · standardstandard

Runtime output language follows lang (default en). Skill docs stay EN-primary.

When to use

UseDon't
(see bullets)(see bullets)

Use

  • Stack/library/protocol decisions
  • Cross-team “why we chose X”
  • Superseding an old decision

Don't

  • Daily task tickets
  • Full multi-option RFC (use rfc-outline)
  • Inventing decisions without stakeholders

Deliverable

One ADR page with status + consequences

Full workflow, hard rules, and QA: see SKILL.md.

Example

Monorepo sample (if present): ../../output/samples/adr-writer-example-01.md

License

MIT — see LICENSE.

Attribution

Forged with skill-github (local package; push via external tool). Upstream notes may live in workspace AUTHORS.md / sources/.

Related repositories

Similar projects matched by category, topics, and programming language.

MoonshotAI
Featured
MoonshotAI GitHub avatar

Kimi-K3

Kimi K3 is an open-weight, 2.8T-parameter native multimodal agentic model with a 1M-token context window, designed for frontier coding, knowledge work, and reasoning tasks.

AI & Machine LearningAI Agents
3,348
xuchonglang
Featured
xuchonglang GitHub avatar

investing-for-beginners

A structured investing guide for Chinese beginners covering US stocks, options, and cryptocurrency, with focus on foundational concepts and risk awareness.

Blockchain & Web3
2,739
Krishnagangwal
Featured
Krishnagangwal GitHub avatar

CS-Fundamentals

A curated collection of Computer Science fundamentals (PDFs, notes, cheatsheets, interview question banks) for placement preparation, covering seven core subjects plus general resources.

Data & DatabasesDatabases & Storage
2,326