Agent Skills: Documentation (ADR & Runbook)

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

UncategorizedID: nguyenthienthanh/aura-frog/documentation

Install this agent skill to your local

pnpm dlx add-skill https://github.com/nguyenthienthanh/aura-frog/tree/HEAD/aura-frog/skills/documentation

Skill Files

Browse the full folder contents for documentation.

Download Skill

Loading file tree…

aura-frog/skills/documentation/SKILL.md

Skill Metadata

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

AI-consumed reference. Optimized for Claude to read during execution. Human-readable explanation: see docs/architecture/HIERARCHICAL_PLANNING.md or 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

# 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

# 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