SuperAPI AI 工具集

report-writer

前端与建站

查看项目

更新于 10-16 06:22

技能介绍

用途:在完成工单、调试调查、重构或架构决策后,生成一份专业、独立的 HTML 报告,记录做了什么以及为什么这样做,并自动在默认浏览器中打开。

主要能力:支持多种报告类型,包括 Bug 修复报告、功能报告、重构报告、调查/调试报告,以及数据探索/交互式仪表盘报告。叙述型报告包含问题陈述、根因分析、调查时间线、解决方案、变更文件、测试、影响评估等章节;数据探索型报告则输出单个 HTML 文件,让读者自行筛选、切片、绘图并导出数据集。

使用方式:可通过命令调用,如 /report-writer PROJ-1234、/report-writer auth-migration-investigation,或不带参数时根据分支自动命名。生成流程包括用 git 命令收集变更数据(如 git diff、git log、git merge-base),再基于 references/template.html 替换占位符,最后保存到 /tmp 并用 open、xdg-open 或 start 打开。数据探索报告可使用 python references/data-explorer-generator.py --csv data.csv --out report.html --config report_config.json 生成。

适用场景:工单交付后记录、调试会话总结、架构决策文档、重构总结,以及需要让读者自行分析 CSV 等表格数据的合规审计或错误频率导出。

限制:资料未提供收费、价格、平台支持范围等信息;部分具体实现细节(如模板完整内容)暂未提供。