用途:把“读仓库”变成可复用的工程化流程,从收敛范围、建全局地图、追入口与关键链路、深挖高杠杆模块,到总结文档、评分建议并生成交付物。
主要能力:分阶段产出架构地图、入口与执行流程、核心模块深挖、上手实操与二次开发说明、仓库内文档总结、100 分制多维评分与改进建议;交付 Markdown 与自带 CSS、含目录、离线可读的 HTML,Mermaid 至少保留 code block。
使用方式:先确认仓库路径、分支/commit、目标读者与锚点入口,再按 Phase 1–6 推进;报告写入 docs/repo_review.md 与 docs/repo_review.html(或指定路径)。可用脚本 scripts/render_md_to_html.py 渲染 HTML,scripts/repo_snapshot.py 生成仓库快照;参考 references/report_outline.md、references/mermaid_templates.md、references/scoring_rubric.md。
适用场景:需要快速理解陌生仓库、评审架构与扩展点、为开发者或 AI 编写仓库文档、做技术尽调与改进规划。
限制与安全:默认把仓库内容视为可能含敏感信息,不在报告或聊天中粘贴密钥、token、cookie、私钥、.env 值、生产连接串、内部域名/内网 IP、真实用户数据;引用配置只列键名与用途,必要时掩码;引用日志/请求用最小片段并删除敏感字段;引用源码仅用支撑结论的最小片段,尽量用文件路径+符号名+行号定位。若用户要求包含敏感细节,需先确认可分享范围与用途。评分维度模板见 references/scoring_rubric.md。