addy-documentation-and-adrs

Record architectural decisions and documentation for software projects.

Updated Mar 19, 2026

Search Tags:#architecture #documentation #adr #decision-record #project-guidance #engineering-notes

Ready to run

npx skills add https://github.com/japurcell/skills --skill addy-documentation-and-adrs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: addy-documentation-and-adrs
Source: https://github.com/japurcell/skills/tree/main/skills/addy-documentation-and-adrs
Command: npx skills add https://github.com/japurcell/skills --skill addy-documentation-and-adrs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Records decisions and documentation. Use when making architectural decisions, changing public APIs, shipping features, or when you need to record context that future engineers and agents will need to understand the codebase.

Core Features & Use Cases

ADRs capture architectural decisions and rationale to guide future work.
Inline documentation and guidelines help agents follow project conventions.
Lifecycle and structure guidance (add/README, references) to keep decisions discoverable.

Quick Start

Create an ADR under docs/decisions/ to capture the rationale behind a decision and reference it from AGENTS.md.

Frequently Asked Questions about addy-documentation-and-adrs

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

FAQPage Schema

What is an ADR and when should I document architectural decisions?▼

An ADR (Architecture Decision Record) captures architectural decisions and rationale to guide future engineers. You need ADR documentation when making architectural choices, changing public APIs, shipping features, or recording context that future agents will need to understand the codebase.

How do I structure ADR documentation for a software project?▼

Create ADRs under docs/decisions/ to capture decision rationale, then reference them from AGENTS.md. This enforces ADR documentation, inline guidelines, and project-level references to keep architectural decisions discoverable for future engineers.

Does this ADR documentation approach work with existing project guidelines?▼

Yes, it integrates with existing project guidelines by enforcing ADR documentation, inline documentation guidelines, and project-level references via AGENTS.md. It manages ADR lifecycle and structured addy-README and changelog requirements alongside your current conventions.

What's the best way to capture engineering context for future agents?▼

The best way to capture engineering context is combining ADRs for decision rationale with AGENTS.md for project-level references. Enforcing inline documentation guidelines and structured addy-README and changelog requirements provides future agents the necessary codebase context.

Why do I need an AGENTS.md file for decision records?▼

An AGENTS.md file is needed because it provides project-level references and inline documentation guidelines that make ADRs discoverable. It ensures future engineers and agents can locate and understand architectural decisions, API changes, and shipping rationale.