name: error-code-catalog description: 管理和记录SDK错误代码及信息 allowed-tools:
- Read
- Write
- Edit
- Glob
- Grep
- Bash
错误代码目录技能
概述
此技能管理一个全面的SDK错误代码、信息和文档目录,确保所有SDK操作中一致且有用的错误处理。
能力
- 按类别定义错误代码分类法
- 自动生成错误文档
- 验证错误信息的质量和可操作性
- 支持错误本地化(国际化)
- 将HTTP状态码映射到SDK错误
- 根据目录生成错误处理代码
- 跟踪错误频率和模式
- 为每个错误创建故障排除指南
目标流程
- 错误处理和调试支持
- API设计规范
- API文档系统
集成点
- 错误跟踪系统(Sentry, Bugsnag)
- 本地化框架
- 文档生成器
- SDK代码生成
- 分析平台
输入要求
- 错误分类要求
- 信息风格指南
- 本地化要求
- HTTP映射规则
- 故障排除深度
输出产物
- 错误代码目录(JSON/YAML)
- 错误文档页面
- SDK错误类/类型
- 本地化资源文件
- 故障排除指南
- 错误映射表
使用示例
skill:
name: error-code-catalog
context:
catalogFile: ./errors/catalog.yaml
errorFormat:
codePrefix: "SDK"
codeLength: 4
pattern: "SDK-{category}-{number}"
categories:
- auth
- validation
- network
- rate-limit
- server
localization:
enabled: true
locales: ["en", "es", "ja", "de"]
includeRemediation: true
最佳实践
- 使用有意义的错误代码前缀
- 所有错误都包含补救步骤
- 逻辑性地分类错误
- 保持错误信息可操作
- 从一开始就支持本地化
- 将错误链接到文档