documentation

Solid

Create Architecture Decision Records (ADRs) and Runbooks for operational documentation.

AI & Automation 24 stars 3 forks Updated today MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
47
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
60
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

> **AI-consumed reference.** Optimized for Claude to read during execution. > Human-readable explanation: see [docs/architecture/HIERARCHICAL_PLANNING.md](../../../docs/architecture/HIERARCHICAL_PLANNING.md) > or [docs/getting-started/](../../../docs/getting-started/) depending on topic. # Documentation (ADR & Runbook) ## When to Create - **ADR:** Technology choices, architectural changes, new patterns, deprecations - **Runbook:** Service deployment, common ops tasks, incident response ## ADR Template ```markdown # ADR-[N]: [TITLE] **Status:** Proposed | Accepted | Deprecated | Superseded by ADR-X **Date:** YYYY-MM-DD ## Context — ## Decision — ## Options Considered — ## Consequences ``` Location: `docs/adr/ADR-NNN-description.md`. Keep immutable — supersede, don't edit. ## Runbook Template ```markdown # Runbook: [Service] **Owner:** [Team] | **On-Call:** [Contact] ## Prerequisites — ## Common Operations — ## Troubleshooting — ## Alerts & Escalation ``` Location: `docs/runbooks/service-name.md`. Test commands before documenting. ## Principles - ADR: clear problem, options evaluated, consequences documented - Runbook: commands copy-paste-ready, escalation path defined

Details

Author
nguyenthienthanh
Repository
nguyenthienthanh/aura-frog
Created
8 months ago
Last Updated
today
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category