git-adr

What problem does it solve?

This Skill automates the entire lifecycle of Architecture Decision Records (ADRs), from creation to synchronization, by integrating them directly into your Git workflow. It eliminates file clutter, ensures decisions are versioned with your code, and provides AI assistance to streamline documentation, saving you time and reducing manual effort in managing critical architectural choices.

Core Features & Use Cases

• Git-Native ADRs: Stores ADRs in Git notes, keeping your repository clean while ensuring decisions are versioned, portable, and linkable to specific commits. This means your architectural history travels with your code without polluting your working directory.
• AI-Assisted Drafting & Analysis: Leverage AI to quickly draft new ADRs, get suggestions for improving existing ones, summarize past decisions, and ask natural language questions about your architectural history. This significantly speeds up the documentation process.
• Multi-Format Support: Generate ADRs in various professional formats (MADR, Nygard, Y-Statement, Alexandrian, Business Case, Planguage) to match the complexity and audience of each decision, ensuring clarity and consistency.
• Use Case: You've just concluded a meeting deciding on a new message queue. Instead of manually writing a detailed ADR, simply tell the AI, "Draft an ADR for choosing Kafka as our message queue, citing its high throughput and fault tolerance." The Skill will generate a structured ADR, ready for review and commit, saving you the manual effort of formatting and content generation.

Quick Start

Draft an ADR for using PostgreSQL as our primary database, highlighting its JSONB support and ACID compliance.