用途:为陌生代码库生成一份基于学习科学的教学式学习指南,帮助读者建立持久理解,不仅知道代码做什么,还理解其存在原因与各部分关系。
主要能力:以“先目的后结构”为原则,先讲要解决的问题而非文件树;优先呈现2-3个“门槛概念”;按概览→系统→接口→内部逐层展开;包含预测提示、追问式提问与探索任务等主动学习元素;文字解释配图表(双通道编码);明确命名架构模式并附学习资源链接。
使用方式:先通过 AskUserQuestion 确认受众(新团队成员、有经验但新接触该代码库的开发者、跨团队协作者、未来的自己)与深度(完整指南、架构概览、特定子系统)。随后系统探索代码库:入口点、配置、领域模型、主要流程、系统边界、测试结构、现有文档,以及命名约定、错误处理哲学、关键依赖。接着识别2-3个门槛概念,构建概念图(5-8个主要系统/模块及其通信方式与流向),再按模板撰写指南,最后按“森林与树木”、渐进披露、主动元素、模式链接四项检查后交付。
输出:单个 Markdown 文件,通常放在 .claude/docs/study-guide.md 或用户指定位置,指南自包含。图表使用 Mermaid:graph TD 表示架构与数据流,sequenceDiagram 表示请求流,classDiagram 表示领域模型。探索任务遵循 PRIMM 递进:预测→运行→调查→修改。
限制:资料未提供具体安装命令、收费方式、支持平台或效果数据;实际生成质量取决于对目标代码库的探索深度。