A CLI utility that transforms simple text descriptions into fully structured Architecture Decision Records using AI.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install adr-writer
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install adr-writer using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is ADR Writer?
ADR Writer addresses one of the most common bottlenecks in software engineering: the documentation of technical choices. While every developer understands the importance of recording architectural decisions, the process is often skipped due to the manual effort and boilerplate required. This tool simplifies the workflow by generating records that include title, context, decision, and consequences in a standardized format. As a specialized utility in the Openclaw Skills library, it helps teams maintain a source of truth for their technical evolution without the manual overhead, ensuring that the rationale behind every major change is preserved.
ADR Writer Use Cases
- Documenting the shift from monolithic architectures to microservices.
- Recording database selection criteria, such as choosing PostgreSQL over NoSQL options.
- Formalizing framework migrations like moving from Express to Fastify.
- Providing historical context for new developers during team onboarding.
- Satisfying compliance requirements for documented decision-making processes.
How ADR Writer Works
- The developer executes a command using npx with a brief summary of the architectural decision.
- The utility parses the input and applies it to a high-fidelity ADR prompt template.
- The AI engine (GPT-4o-mini) processes the request to generate detailed context and potential consequences.
- The final document is output in Markdown format, ready to be reviewed and committed to version control.
ADR Writer Setup
Ensure you have Node.js 18 or higher installed on your system. You must set your OpenAI API key as an environment variable before running the command.
export OPENAI_API_KEY='your_openai_api_key'
npx ai-adr "your architectural decision description"
ADR Writer Data Schema & Taxonomy
The output follows a standardized Markdown schema designed for technical documentation consistency and readability.
| Component | Description |
|---|---|
| Title | A concise heading for the record identifying the decision. |
| Context | The background information and problem statement necessitating the decision. |
| Decision | The specific action, technology, or architecture choice being documented. |
| Consequences | The resulting impact, including both the benefits and the trade-offs. |
ADR Writer Advanced Features
- Rapid generation of standardized records to ensure consistency across the Openclaw Skills ecosystem.
- Minimal footprint with no permanent installation required through the use of npx.
- Context-aware generation optimized for identifying complex architectural trade-offs.
- Seamless integration with Git workflows to version ADRs alongside the relevant source code.
- Customizable output that can be easily edited to include team-specific nuances.
SKILL.md
Loading
Related Openclaw Skills
ADR Gen
ADR Gen is an AI-driven CLI tool designed to automate the creation of structured Architecture Decision Records to capture technical rationale.
GitHub Action Generator
Convert natural language descriptions into fully functional, production-ready GitHub Actions workflow YAML files.
Accessibility Auditor (a11y-auditor)
An automated scanning tool that identifies WCAG violations in HTML and JSX and provides AI-powered fix suggestions.
Web3 Data Explorer (Chainbase)
A powerful tool for querying and analyzing real-time on-chain blockchain data across multiple EVM-compatible networks using Chainbase APIs.
a11y-checker
An AI-driven CLI tool that scans HTML and JSX for accessibility issues and provides ready-to-use code fixes.
ADR Gen
A zero-config AI tool to generate structured Architecture Decision Records (ADRs) from simple natural language prompts.
Featured*
