architecture-decision-records

Capture architectural decisions as structured ADR documents during Gemini CLI sessions.

Updated Sep 13, 2025
One-click install
npx skills add https://github.com/llmh333/employee_management_spring --skill architecture-decision-records-llmh333
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-decision-records
Source: https://github.com/llmh333/employee_management_spring/tree/main/.gemini/skills/architecture-decision-records
Command: npx skills add https://github.com/llmh333/employee_management_spring --skill architecture-decision-records-llmh333

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams avoid losing architectural rationale by turning important decision moments into structured, versionable ADRs that live alongside the code.

Core Features & Use Cases

  • Decision capture on demand: Records ADRs when users explicitly request ADRs or make significant framework/library/pattern/database/API/infrastructure/security choices.
  • Consistent ADR structure: Enforces a lightweight Nygard-style format covering context, decision, alternatives, consequences, and risks.
  • Read and trace rationale: Answers “why did we choose X?” by searching an ADR index and presenting relevant Context and Decision sections.

Quick Start

Ask the assistant to record an architectural decision you just made, including the competing alternatives and the reason you selected the final approach.

Frequently Asked Questions about architecture-decision-records

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document architecture decisions and trade-offs during a CLI session?

You document architecture decisions by requesting the assistant to record the context, alternatives, and rationale into a structured Architecture Decision Record. This captures trade-offs as versionable files alongside your code for long-term traceability.

What is an ADR and when should I write one for my software project?

An ADR is a lightweight Nygard-style document that records context, decision, alternatives, consequences, and risks. You should write one when making significant framework, database, API, or infrastructure choices to ensure rationale traceability.

Can I retrieve the rationale for why a specific framework or pattern was chosen?

Yes, you can retrieve rationale by asking the assistant to search the ADR index. It will readback existing Architecture Decision Records and present the relevant Context and Decision sections to explain why a specific choice was made.

How to log API and data modeling choices as structured decision records?

You log API and data modeling choices by explicitly asking the assistant to record the decision. It applies a consistent Nygard-style format covering context, alternatives, and consequences, requiring your confirmation before writing the new ADR file.

Does the ADR creation process require explicit user confirmation before writing files?

Yes, the architecture decision record creation process requires explicit user confirmation. The assistant will not automatically write new ADR files or modify the index without your direct approval during the CLI session.

What is the best way to maintain an index of architectural decisions for a team?

The best way to maintain an index of architectural decisions is using structured ADR files. This Skill automatically maintains an ADR index, allowing teams to search and trace the rationale behind framework, infrastructure, and security choices.