Adr Writer
by openclaw
Generate Architecture Decision Records with AI. Use when documenting technical decisions.
Skill Details
Repository Files
8 files in this skill directory
name: adr-writer description: Generate Architecture Decision Records with AI. Use when documenting technical decisions.
ADR Writer
Writing Architecture Decision Records is one of those things everyone knows they should do but nobody actually does. Too much boilerplate, too much thinking about format when you should be thinking about the decision itself. This tool fixes that.
One command. Zero config. Just works.
Quick Start
npx ai-adr "switch from REST to GraphQL"
What It Does
- Generates complete ADRs in standard format (title, context, decision, consequences)
- Handles the boring structure so you focus on the actual decision
- Creates consistent documentation your team can actually reference later
- Works with any architectural decision from database choices to framework migrations
Usage Examples
# Database decision
npx ai-adr "use PostgreSQL over MongoDB for transactional data"
# Architecture pattern
npx ai-adr "adopt microservices instead of monolith"
# Framework choice
npx ai-adr "migrate from Express to Fastify"
# Infrastructure
npx ai-adr "move to Kubernetes from Docker Compose"
Best Practices
- Be specific - "switch to GraphQL for mobile clients" beats "change API"
- Include context - mention why you're making this decision in your description
- Review the output - AI gets you 80% there, but add your team's specific context
- Keep them versioned - commit ADRs alongside the code they document
When to Use This
- Starting a new project and need to document initial tech choices
- Making a significant architectural change that future devs will question
- Onboarding new team members who need to understand past decisions
- Satisfying compliance requirements for decision documentation
Part of the LXGIC Dev Toolkit
This is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.
Find more:
- GitHub: https://github.com/LXGIC-Studios
- Twitter: https://x.com/lxgicstudios
- Substack: https://lxgicstudios.substack.com
- Website: https://lxgic.dev
Requirements
No install needed. Just run with npx. Node.js 18+ recommended. Needs OPENAI_API_KEY environment variable.
npx ai-adr --help
How It Works
Takes your plain English description of an architectural decision, sends it to GPT-4o-mini with a prompt optimized for ADR format, and returns a complete, well-structured document. The output follows the standard ADR template used by most engineering teams.
License
MIT. Free forever. Use it however you want.
Related Skills
Dbt Transformation Patterns
Master dbt (data build tool) for analytics engineering with model organization, testing, documentation, and incremental strategies. Use when building data transformations, creating data models, or implementing analytics engineering best practices.
Clinical Decision Support
Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug develo
Scientific Schematics
Create publication-quality scientific diagrams using Nano Banana Pro AI with smart iterative refinement. Uses Gemini 3 Pro for quality review. Only regenerates if quality is below threshold for your document type. Specialized in neural network architectures, system diagrams, flowcharts, biological pathways, and complex scientific visualizations.
Mermaid Diagrams
Comprehensive guide for creating software diagrams using Mermaid syntax. Use when users need to create, visualize, or document software through diagrams including class diagrams (domain modeling, object-oriented design), sequence diagrams (application flows, API interactions, code execution), flowcharts (processes, algorithms, user journeys), entity relationship diagrams (database schemas), C4 architecture diagrams (system context, containers, components), state diagrams, git graphs, pie charts,
Diagram Generation
Mermaid diagram generation for architecture visualization, data flow diagrams, and component relationships. Use for documentation, PR descriptions, and architectural analysis.
Scientific Schematics
Create publication-quality scientific diagrams using Nano Banana Pro AI with smart iterative refinement. Uses Gemini 3 Pro for quality review. Only regenerates if quality is below threshold for your document type. Specialized in neural network architectures, system diagrams, flowcharts, biological pathways, and complex scientific visualizations.
Clinical Decision Support
Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug develo
Materialize Docs
Materialize documentation for SQL syntax, data ingestion, concepts, and best practices. Use when users ask about Materialize queries, sources, sinks, views, or clusters.
Dbt Transformation Patterns
Master dbt (data build tool) for analytics engineering with model organization, testing, documentation, and incremental strategies. Use when building data transformations, creating data models, or implementing analytics engineering best practices.
Mermaidjs V11
Create diagrams and visualizations using Mermaid.js v11 syntax. Use when generating flowcharts, sequence diagrams, class diagrams, state diagrams, ER diagrams, Gantt charts, user journeys, timelines, architecture diagrams, or any of 24+ diagram types. Supports JavaScript API integration, CLI rendering to SVG/PNG/PDF, theming, configuration, and accessibility features. Essential for documentation, technical diagrams, project planning, system architecture, and visual communication.