SuperAPI AI 工具集

report

通用与其它

查看项目

更新于 10-16 04:31

技能介绍

report 用于将调查、分析、审计或评审工作汇总为结构化的 GitHub Flavored Markdown(GFM)报告,适合错误排查、性能与代码分析、安全审计、代码或架构评审、调试记录等场景。

在 Claude Code 中运行时,它会用 AskUserQuestion 工具先确认报告类型(Investigation、Analysis、Audit、Review)和保存位置(docs/reports/ 推荐、docs/ 或项目根目录)。若处于 Auto Mode(连续自动执行),则跳过提问,默认类型为 Investigation(或用户已指定的类型),位置为 docs/reports/,并在最终摘要中用一行说明所选值供用户更正。

文件命名格式为 {topic}-{YYYY-MM-DD}-{HHmm}.md,主题小写、连字符分隔,例如 error-investigation-2025-11-13-1430.md。目录不存在时执行 mkdir -p docs/reports 创建。

报告固定包含标题与元信息(Created、Author、Type)以及 Summary、Background、Investigation/Analysis Details、Findings、Recommendations、Conclusion、Additional Information 等章节。格式要求:使用 GFM,代码块标注语言,diff 使用 ```diff,积极使用表格,文件路径写成链接,用 ## 或 ### 建立层级。保存后显示文件路径、摘要(章节数、字符数等)和创建时间。

限制:资料未提供运行环境依赖、安装方式、收费或价格、平台支持范围及效果保证等信息;Auto Mode 下的默认值仅为约定,需用户自行核对。