用途:Project Teacher 用于为当前项目或任务生成详细讲解,重点说明“为什么”和“怎么做”,帮助用户学习。触发后会生成一份 Markdown 学习文档。
主要能力:生成包含 YAML frontmatter(last、commit、tags)和人类可读提示的文档;提供代码索引(Code index)快速跳转到相关文件;用纯语言解释项目全貌;用 ASCII 图或 Mermaid 图展示架构与数据流;说明关键技术决策及其权衡与备选方案;记录版本历史;以反思问题结尾但不给答案。
使用方式:先检查输出目录(默认 learning/)中是否已有相关文档,若找到会询问用户是更新还是新建快照。更新时重命名日期后缀、更新 frontmatter 的 last 与 commit、重写过时内容并保留仍适用的历史上下文、在底部 ## Version history 追加记录。用户可指定保存位置(如 Obsidian vault);若保存到外部 Obsidian vault,先检查其根目录或 .cursor/、.claude/ 中的上下文文件并遵循其说明。默认保存到项目根目录的 learning/,不存在则创建;关键:检查 learning/ 是否在 .gitignore 中,若不在则加入,避免个人文档提交到共享仓库。文件命名为“[描述性标题] - [YYYY-MM-DD].md”。
写作风格:标题使用句子式大小写、描述性命名;优先使用可视化图表;始终包含权衡部分;结尾提出挑战理解的反思问题;以专家导师口吻面向聪明同事讲解。
限制:资料未提供具体安装命令、收费、价格、平台支持或效果数据;文档模板可根据内容灵活调整,不必强行套用固定结构。