adr-gen

Generate Markdown ADRs with context, alternatives, and reasoning from decisions.

1|Updated Jan 30, 2026
One-click install
npx skills add https://github.com/jieni777/opencode-config-backup --skill adr-gen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-gen
Source: https://github.com/jieni777/opencode-config-backup/tree/main/skills/adr-gen
Command: npx skills add https://github.com/jieni777/opencode-config-backup --skill adr-gen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ADRs are essential for capturing why a decision was made, but teams often struggle to document and maintain architectural rationale. This Skill automates ADR generation to ensure decisions are tracked with context, alternatives considered, and reasoning.

Core Features & Use Cases

  • Auto-generates ADR documents in Markdown
  • Captures Context, Decision, Consequences and Alternatives
  • Supports consistent ADR structure for documentation and onboarding

Quick Start

Run npx ai-adr "Switch from REST to GraphQL" to generate an ADR.

Frequently Asked Questions about adr-gen

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

FAQPage Schema
How do I generate an Architecture Decision Record from a software decision?

Generate an Architecture Decision Record by running npx ai-adr with your decision topic to auto-produce a markdown file capturing context, alternatives, and reasoning. This enforces consistent ADR fields including Title, Status, Context, Decision, Consequences, and Alternatives for documentation.

What is an ADR and what fields should it include for software architecture documentation?

An ADR is an Architecture Decision Record that captures why a decision was made across software projects and lifecycles. It should include Title, Status, Context, Decision, Consequences, and Alternatives to ensure architectural rationale is consistently tracked and maintained for onboarding.

Can I automate ADR creation in markdown for my engineering team?

Yes, you can automate ADR creation in markdown by running the CLI tool with a decision description. It outputs a structured markdown document with context and consequences, ensuring teams maintain consistent architecture documentation without manual formatting overhead.

What's the best way to document architectural context and alternatives considered during a project?

The best way to document architectural context and alternatives is to generate a structured ADR in markdown. By enforcing fields for Context, Alternatives, and Consequences, the approach ensures all architectural rationale and decision reasoning is consistently captured for future reference.

Do I need to manually format markdown when writing architecture decision records?

No, manual markdown formatting is not needed for architecture decision records. The generation tool enforces the ADR structure and automatically outputs properly formatted markdown with all required fields, reducing documentation overhead and maintaining consistency across software projects.