SuperAPI AI 工具集

codebase-briefing-report

通用与其它

查看项目

更新于 10-15 17:29

技能介绍

用途:将陌生或演进中的仓库探索整理为一份自包含的 Markdown 报告,包含系统定位、结构、指标与风险,供新成员或干系人冷读,而非调查过程的日志。

主要能力:按四个阶段产出报告。阶段一 Orient,读取 README、CONTRIBUTING、包描述文件,检测语言与构建运行方式,用一段话说明系统用途、使用者与运行方式。阶段二 Map,枚举顶层目录职责、入口点、模块依赖方向,产出模块表(名称、职责、关键文件、依赖)。阶段三 Measure,统计可计算的指标,如文件数、按语言 LOC、提交数、贡献者、最后变更日期、热点文件、测试文件数、是否运行测试套件、lint/typecheck 配置、CI 步骤、依赖数;无法计算则标注“not measured”。阶段四 Assess,列出风险,每条含一行陈述、Low/Med/High 评级与具体下一步行动,覆盖测试缺口、单点故障、依赖陈旧/安全、未文档化的承重区域、分层违规等,并以 3–5 条“If You Read Nothing Else”收尾。

输出:写入单一文件 docs/reports/CODEBASE-REPORT.md(可按调用仓库约定覆盖路径并记录)。必需章节依次为:Header(仓库名、commit SHA、生成日期、作者/agent)、What It Is、Architecture Overview(含 ASCII 或 Mermaid 图)、Module Map、Metrics、Health & Risk Summary、If You Read Nothing Else。

使用方式:在目标仓库根目录,用 git rev-parse --short HEAD 获取头部所需 SHA,git log -1 --format='%cd' --date=short 获取最后变更日期,再依次执行四阶段。

限制与约束:每条架构声明必须可追溯到文件、目录或命令输出;报告仅描述单一 commit 的状态并记录 SHA,不叙述发现过程;风险必须命名并评级,附具体下一步行动;不得编造指标,无法计算就写“not measured”;只产出一个文件,不分散到多个文件。若产物读起来像搜索日志、模块表有遗漏、指标为空或健康度全绿,需按资料中给出的排查项修正。