ADR Format

Name: ADR Format
Availability: InStock
Author: hjung3113

Create and manage architectural decision records in markdown files.

Updated Apr 20, 2026

Search Tags:#architecture #documentation #system design #adr #decision

Ready to run

npx skills add https://github.com/hjung3113/vocpage --skill adr-format-hjung3113

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ADR Format
Source: https://github.com/hjung3113/vocpage/tree/main/.agents/skills/grill-with-docs
Command: npx skills add https://github.com/hjung3113/vocpage --skill adr-format-hjung3113

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams systematically record architectural decisions and their context, ensuring clarity and traceability over project evolution.

Core Features & Use Cases

Create and manage ADRs: Write ADRs following a simple template with optional sections for status, options, and consequences.
Organize decision logs: Maintain sequential or structured documentation of key project choices.
Use Case: Document a critical tech stack choice or a system boundary decision to facilitate onboarding and future reviews.

Quick Start

Create an ADR in docs/adr/ with a filename like 0001-choose-library.md, include a short decision summary, and add the context, options, and reasons directly in the file.

Frequently Asked Questions about ADR Format

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

FAQPage Schema

How do I document architectural decisions for my system design?▼

You can document architectural decisions by creating sequential markdown files within a `docs/adr/` directory, detailing the context, options, and reasons for critical technology or system boundary choices.

What is the best way to track technology trade-offs during project evolution?▼

Tracking technology trade-offs is best achieved by recording sequential Architecture Decision Records that capture decision context and consequences, providing a historical log that facilitates future reviews and onboarding.

When do I need to create an Architecture Decision Record?▼

You need an Architecture Decision Record when documenting critical choices related to technology selection, design trade-offs, or system boundaries to ensure clarity and traceability over project evolution.

How should I structure ADR files to maintain a decision log?▼

Structure ADR files by naming them sequentially like `0001-choose-library.md` in the `docs/adr/` folder, using a simple template with optional sections for status, options, and consequences to maintain an organized decision log.

Does this approach to system design documentation require specific dependencies?▼

This approach to system design documentation requires no specific dependencies, relying only on standard markdown files to record architectural decisions and their context within your project repository.