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.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
功能与用途
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.
快速开始
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
使用指南 ↗使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-02-10
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!