documentation-and-adrs

Name: documentation-and-adrs
Availability: InStock
Author: LazyIsEfficient

Create ADRs and linked README documentation for architectural decisions.

15|3|Updated Apr 9, 2026

Search Tags:#changelog #architecture #documentation #adr #readme #api-docs #decision-record

Ready to run

npx skills add https://github.com/LazyIsEfficient/agentic-os --skill documentation-and-adrs-lazyisefficient

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/LazyIsEfficient/agentic-os/tree/main/.claude/skills/documentation-and-adrs
Command: npx skills add https://github.com/LazyIsEfficient/agentic-os --skill documentation-and-adrs-lazyisefficient

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Records architectural decisions and ADRs with clear, centralized documentation to reduce rework, align engineering teams, and preserve rationale for future features.

Core Features & Use Cases

ADR creation and maintenance for major architectural decisions, APIs, data models, and public interfaces.
Documentation governance that links ADRs to READMEs, API docs, and changelogs to maintain consistency across projects.
Quick-start guidance and templates for teams to start documenting decisions and onboarding new engineers.

Quick Start

Create an ADR and corresponding README outline for a new architectural decision.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema

How do I create an architecture decision record for API design changes?▼

To create an architecture decision record for API design, use enforced ADR templates and decision-record formats that capture context, decision, and consequences. The system links these records directly to your README and API docs for consistent traceability.

What is the best way to maintain changelog consistency across multiple projects?▼

Maintaining changelog consistency requires documentation governance that links ADRs to READMEs, API docs, and changelogs. By applying enforced templates stored in the repository, engineering teams align architectural decisions and onboarding materials across projects.

How do I document data model decisions for onboarding new engineers?▼

Document data model decisions by creating ADRs with standardized templates and generating linked README outlines. This centralized documentation preserves the rationale for architectural choices, reducing rework and accelerating onboarding for new engineers.

When do I need to write an ADR instead of just updating a README?▼

You need to write an ADR when capturing major architectural decisions, public interfaces, or data models requiring long-term rationale preservation. README updates provide quick-start guidance, while ADRs enforce structured decision records for future reference.

Can I enforce a specific template for decision records in my repository?▼

Yes, you can enforce specific ADR templates and decision-record formats stored directly in your repository. This ensures all architectural decisions, API designs, and data model changes follow consistent documentation structure across the engineering team.

Why does linking architecture decisions to API docs reduce rework?▼

Linking architecture decisions to API docs reduces rework by maintaining centralized documentation governance. When ADRs connect to READMEs and changelogs, teams preserve decision rationale, align on interfaces, and avoid contradicting previous architectural choices.