documentation-and-adrs

Record architecture decisions and rationale in structured ADR templates.

6|Updated Feb 17, 2026

Search Tags:#documentation #onboarding #adr #traceability #architecture-decision #knowledge-transfer #decision-record

Ready to run

npx skills add https://github.com/farzanmrz/oparax-chirp --skill documentation-and-adrs-farzanmrz

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Records decisions, context, and documentation to help future engineers understand why code and APIs were built the way they were, not just what was built.

Core Features & Use Cases

Architecture Decision Records (ADRs): Write, organize, and reference ADRs to justify frameworks, data models, API designs, and deployment choices.
Documentation Strategy: Capture context, constraints, and trade-offs to reduce onboarding and rework.
Onboarding & Knowledge Transfer: Provide engineers and agents with rationale and historical decisions for faster ramp-up.

Quick Start

Create a new ADR to capture the rationale behind a significant 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 write an Architecture Decision Record to document API design choices?▼

To write an Architecture Decision Record, use structured ADR templates to capture context, constraints, and trade-offs for API design choices. This enforces centralized documentation with consistent reference paths for future maintenance.

What is the best way to document architectural rationale for future code maintenance?▼

The best way to document architectural rationale is recording decisions and context using structured templates. This approach captures trade-offs and constraints, ensuring traceability across major architectural changes and policy definitions.

How do I create documentation that speeds up onboarding and knowledge transfer for engineers?▼

To create documentation that speeds up onboarding, record historical decisions and architectural rationale using centralized ADRs. This provides engineers and agents with the context needed for faster ramp-up and reduced rework.

When should I use an ADR instead of general documentation for a framework decision?▼

Use an ADR for major architectural changes, framework selections, data model designs, and deployment choices. It enforces structured templates to justify decisions and capture trade-offs, whereas general documentation typically only captures what was built.

Can I use ADRs to establish traceability across major policy definitions in a project?▼

Yes, you can use ADRs to establish traceability across major policy definitions in a project. They enforce centralized documentation and consistent reference paths to capture context, constraints, and trade-offs for future engineers.