documentation

Installation
SKILL.md

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
Related skills
Installs
7
GitHub Stars
17
First Seen
Jan 25, 2026