error-documentation
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.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Features and purpose
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.
Quick start
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
Guides ↗Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-02-10
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!