SuperAPI AI Directory

documentation

Writing & research

View repository

Updated 10-16 09:35

About this skill

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

  • Runbook: Service deployment, common ops tasks, incident response
  • ADR: → use skills/tech-writing + templates/decision-record.md. That template carries the full 4-tier ladder (Y-statement → Nygard ADR → MADR → RFC) and picks the tier by decision size. The stripped ADR template below is kept only so existing links keep resolving.

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