Adr Writer

Documents

adr-writer

Adr Writer is an Agent Skill for documents published in the oxbshw/LLM-Agents-Ecosystem-Handbook repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when capturing an architecture decision so it survives turnover — produces an ADR-NNNN.md from context, options considered, and the chosen path.

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/oxbshw/LLM-Agents-Ecosystem-Handbook/blob/HEAD/skills/catalog/adr-writer/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/adr-writer, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

ADR Writer

When to use

A non-trivial architecture decision was just made
Reverse-documenting a decision that wasn't recorded but should have been
Preparing for a design review

When NOT to use

Trivial choices (naming, formatting)
Operational runbooks (those go to runbooks/)
Product decisions without architectural impact

Inputs

Name	Type	Required	Notes
`context`	string	yes	The problem being solved, in 2–4 sentences
`options`	list	yes	Alternatives considered
`decision`	string	yes	Chosen path
`number`	int	no	If omitted, finds next ADR number from `memory/decisions/`

Outputs

A file at memory/decisions/ADR-NNNN-<slug>.md matching the ADR template.

Workflow

Find the next ADR number (or use number input)
Slugify the decision's main subject
Fill the template:
- Context, Decision, Alternatives, Consequences (positive + negative)
- Status: accepted (default), proposed, superseded by ADR-XXXX
Write to memory/decisions/ADR-NNNN-<slug>.md
Add a one-line entry to MEMORY.md#decisions