名称: 可操作错误格式化器 描述: 格式化错误信息,包含可操作的修复建议和文档链接 允许使用的工具:
- 读取
- 写入
- 编辑
- 全局查找
- 文本搜索
- Bash命令
可操作错误格式化器 技能
概述
此技能用于格式化SDK错误,使其包含可操作的修复建议、文档链接和上下文帮助,从而帮助开发者快速解决问题。
能力
- 生成有帮助、有上下文的错误信息
- 根据错误上下文包含修复建议
- 添加相关页面的文档链接
- 支持包含详细信息的调试模式
- 格式化堆栈跟踪以提高可读性
- 包含请求关联ID
- 建议相关的故障排除指南
- 支持结构化错误输出(JSON)
目标流程
- 错误处理与调试支持
- 开发者体验优化
- 日志记录与诊断
集成点
- 错误处理框架
- 日志记录系统
- 文档平台
- 调试工具
- IDE集成
输入要求
- 错误目录参考
- 文档URL模式
- 上下文提取规则
- 详细级别定义
- 堆栈跟踪格式化偏好
输出产物
- 错误格式化库
- 消息模板
- 文档链接生成器
- 调试模式实现
- 堆栈跟踪格式化器
- 结构化错误模式
使用示例
技能:
名称: 可操作错误格式化器
上下文:
错误目录: ./errors/catalog.yaml
文档基础网址: "https://docs.example.com/errors"
格式化:
包含堆栈跟踪: 开发环境
包含请求ID: 是
包含建议: 是
最大建议数: 3
详细级别:
- 最小
- 标准
- 详细
- 调试
最佳实践
- 使修复建议具体且可操作
- 链接到相关文档部分
- 包含用于支持查询的请求ID
- 提供不同的详细级别
- 格式化堆栈跟踪以提高可读性
- 避免暴露敏感信息