create-adr

Solid

Creates a NEW Architectural Decision Record (ADR) documenting a specific architectural decision. Use when the user requests "Create ADR for [topic]", "Document decision about [topic]", "Write ADR for [choice]", or when documenting technology choices, patterns, or architectural approaches. Do NOT use for reviews (use architecture-review or specialist-review), checking existing ADRs (use architecture-status), or general documentation.

AI & Automation 73 stars 11 forks Updated 4 days ago

Install

View on GitHub

Quality Score: 78/100

Stars 20%
62
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
0
Description 5%
100

Skill Content

# Create Architectural Decision Record (ADR) Creates structured ADRs following the framework's template. ## Process ### 1. Gather Context Ask if needed: - What decision is being made? - What problem does it solve? - What alternatives were considered? - What are the trade-offs? ### 2. Generate ADR Number ```bash # Find highest ADR number ls .architecture/decisions/adrs/ | grep -E "^ADR-[0-9]+" | sed 's/ADR-//' | sed 's/-.*//' | sort -n | tail -1 ``` New ADR = next sequential number (e.g., if highest is 003, create 004) ### 3. Validate and Sanitize Input **Security**: Sanitize user input to prevent path traversal and injection: - Remove or replace: `..`, `/`, `\`, null bytes, control characters - Convert to lowercase kebab-case: spaces → hyphens, remove special chars - Limit length: max 80 characters for filename portion - Validate result: ensure filename contains only [a-z0-9-] ### 4. Create Filename Format: `ADR-XXX-kebab-case-title.md` Examples: - `ADR-001-use-react-for-frontend.md` - `ADR-002-choose-postgresql-database.md` **Valid input**: "Use React for Frontend" → `use-react-for-frontend` **Invalid blocked**: "../etc/passwd" → sanitized or rejected ### 5. Check Configuration - Read `.architecture/config.yml` to check if pragmatic_mode is enabled - If enabled and applies to ADR creation, include Pragmatic Enforcer analysis ### 6. Write ADR Use the template from `.architecture/templates/adr-template.md`: **Core sections**: - Status, Context, Decision Drivers, Dec...

Details

Author
codenamev
Repository
codenamev/ai-software-architect
Created
1 years ago
Last Updated
4 days ago
Language
JavaScript
License
None

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category