home / skills / jeremylongshore / claude-code-plugins-plus-skills / adr-generator

adr-generator skill

This skill automates adr generator tasks by providing step-by-step guidance, production-ready code, and validation aligned with industry best practices.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill adr-generator

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

2.1 KB

---
name: "adr-generator"
description: |
  Generate adr generator operations. Auto-activating skill for Technical Documentation.
  Triggers on: adr generator, adr generator
  Part of the Technical Documentation skill category. Use when working with adr generator functionality. Trigger with phrases like "adr generator", "adr generator", "adr".
allowed-tools: "Read, Write, Edit, Bash(cmd:*), Grep"
version: 1.0.0
license: MIT
author: "Jeremy Longshore <[email protected]>"
---

# Adr Generator

## Overview

This skill provides automated assistance for adr generator tasks within the Technical Documentation domain.

## When to Use

This skill activates automatically when you:
- Mention "adr generator" in your request
- Ask about adr generator patterns or best practices
- Need help with technical documentation skills covering api docs, user guides, architecture docs, and documentation automation.

## Instructions

1. Provides step-by-step guidance for adr generator
2. Follows industry best practices and patterns
3. Generates production-ready code and configurations
4. Validates outputs against common standards

## Examples

**Example: Basic Usage**
Request: "Help me with adr generator"
Result: Provides step-by-step guidance and generates appropriate configurations


## Prerequisites

- Relevant development environment configured
- Access to necessary tools and services
- Basic understanding of technical documentation concepts


## Output

- Generated configurations and code
- Best practice recommendations
- Validation results


## Error Handling

| Error | Cause | Solution |
|-------|-------|----------|
| Configuration invalid | Missing required fields | Check documentation for required parameters |
| Tool not found | Dependency not installed | Install required tools per prerequisites |
| Permission denied | Insufficient access | Verify credentials and permissions |


## Resources

- Official documentation for related tools
- Best practices guides
- Community examples and tutorials

## Related Skills

Part of the **Technical Documentation** skill category.
Tags: documentation, markdown, api-docs, readme, technical-writing

Overview

This skill automates ADR (Architecture Decision Record) generator tasks for Technical Documentation. It produces step-by-step guidance, validated configurations, and production-ready artifacts to streamline documenting architecture decisions. Use it to standardize ADR creation and integrate ADRs into documentation workflows.

How this skill works

When triggered by phrases like "adr generator" or "adr", the skill analyzes the requested decision context and produces a complete ADR draft following common templates and best practices. It can generate configuration files, sample code snippets, and validation checks to ensure the ADR meets expected structure and metadata requirements. Outputs are ready to paste into repositories or integrate into documentation pipelines.

When to use it

You need a new ADR drafted from decision details or meeting notes
You want to convert decision context into a standard ADR template
You need to validate ADR metadata and formatting before committing
You are automating ADR creation as part of CI/CD or docs pipelines
You want production-ready examples and config snippets for ADR tooling

Best practices

Provide clear context: motivations, alternatives, and consequences
Use consistent metadata fields (date, status, authors, tags)
Keep each ADR focused on a single decision to simplify future reviews
Automate validation checks in CI to enforce ADR structure and links
Integrate ADRs into changelogs and architecture docs for visibility

Example use cases

Generate an ADR from a design discussion summarizing trade-offs and chosen solution
Produce CI-friendly ADR markdown with front-matter for static site generators
Validate existing ADRs for missing fields or formatting issues before PR merge
Create multiple ADR drafts from a list of decisions for a release retrospective
Provide sample code and config snippets illustrating the adopted architecture pattern

FAQ

What templates does the generator use?

It uses common ADR templates with sections for context, decision, alternatives, consequences, and metadata; templates can be adjusted to project conventions.

Can it validate ADRs automatically?

Yes — it performs structural checks and flags missing fields or invalid metadata that can be integrated into CI checks.