error-documentation

Fonctions et usage

Comprehensive error documentation patterns for APIs, libraries, and systems. Covers error catalogs, troubleshooting guides, recovery procedures, and runbook creation to improve developer experience and reduce support burden. Anchors: • The Pragmatic Programmer (Hunt, Thomas) / 適用: error communication / 目的: clear actionable messages • Site Reliability Engineering (Google) / 適用: runbook patterns / 目的: operational excellence • API Design Patterns (JJ Geewax) / 適用: error response design / 目的: consistent error contracts Trigger: Use when documenting API errors, creating error catalogs, writing troubleshooting guides, designing runbooks, standardizing error responses, improving error discoverability.

Démarrage rapide

Suivez les instructions du dépôt pour votre agent. Consultez les fichiers et dépendances avant l’installation.