adr-writer

Creates and maintains Architecture Decision Records in a standardized Status/Context/Decision/Consequences format.

1|Updated Jun 2, 2026
One-click install
npx skills add https://github.com/psiagoleal/ai-coding-agent-profiles --skill adr-writer-psiagoleal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-writer
Source: https://github.com/psiagoleal/ai-coding-agent-profiles/tree/main/skills/adr-writer
Command: npx skills add https://github.com/psiagoleal/ai-coding-agent-profiles --skill adr-writer-psiagoleal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Architectural decisions in software projects are often made informally and forgotten, leading AI agents and developers to propose changes that silently conflict with past choices. This Skill enforces a disciplined ADR workflow so every significant technical decision is documented, numbered, and consulted before new changes are proposed. ## Core Features & Use Cases - ADR Creation from Template: Generates sequentially numbered ADR files (e.g., docs/adr/0001-titulo.md) with the five mandatory blocks: Status, Context, Decision, Consequences, and Code Compliance Directive. - Conflict Detection: Requires reading all active ADRs in docs/adr/ before proposing functional changes, and stops to report any conflict with an Accepted ADR instead of silently bypassing it. - Immutability & Superseding: Enforces that accepted ADRs are never edited; reversals are handled by creating a new ADR that marks the old one as Superseded by ADR-NNNN. - Use Case: When deciding to adopt a new library or solver, the Skill checks existing ADRs, drafts a new numbered ADR with explicit prohibited/required code rules, and updates the docs/adr/README.md index. ## Quick Start Ask the agent to register the decision to adopt library X as an ADR in docs/adr following the project template.

Frequently Asked Questions about adr-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write an Architecture Decision Record for a software project?

Create a numbered Markdown file in docs/adr using the five-block structure: Status, Context, Decision, Consequences, and Code Compliance Directive. State the decision in active voice and list what is prohibited and required in the codebase.

What sections should an ADR template contain?

This template requires Status (Proposed, Accepted, Deprecated, or Superseded), Context describing the forces at play, the Decision itself, Consequences including accepted trade-offs, and a Code Compliance Directive stating prohibited and mandatory practices.

Can I edit an ADR after it has been accepted?

No, accepted ADRs are immutable. To reverse a decision, create a new ADR and mark the old one with the status Superseded by ADR-NNNN, preserving the historical record of why the original choice was made.

How are ADR files named and numbered?

Files live in docs/adr and follow the pattern NNNN-titulo-em-kebab-case.md, where NNNN is a zero-padded sequential number like 0001 or 0002. An index in docs/adr/README.md tracks the current status of each record.

What happens when a proposed change conflicts with an existing ADR?

The workflow requires reading all active ADRs before proposing functional changes. If the change conflicts with an Accepted ADR, the agent must stop and report the conflict rather than silently working around the prior decision.