SuperAPI AI 工具集

codebase-study-guide

通用与其它

查看项目

更新于 10-16 08:03

技能介绍

用途:为不熟悉的代码库生成教学型学习指南,面向新成员入职、资深开发者接手新项目、跨团队协作者或自我参考等场景。

主要能力:采用有依据的学习原理组织内容,包括先讲目的再讲结构、优先呈现 2-3 个阈值概念、渐进式展开复杂度、加入主动学习元素、文字配图表双通道编码,并显式命名架构模式。

使用方式:先通过 AskUserQuestion 明确受众与深度(完整指南、架构概览或特定子系统);再系统探索代码库,顺序为入口点、配置、领域模型、主要流程、系统边界、测试结构、现有文档,并关注命名约定、错误处理理念与关键依赖;然后识别阈值概念、构建概念图,按模板撰写指南并进行审查交付。输出为单个 Markdown 文件,建议放在 .claude/docs/study-guide.md 或用户指定位置。

内容要求:每个系统模块先讲目的后讲机制,附细化提问、命名模式及链接、代表性代码片段与独立探索任务;图表使用 Mermaid(graph TD、sequenceDiagram、classDiagram),每个图聚焦一个概念;探索任务遵循 PRIMM 进程:预测、运行、调查、修改。

限制:资料未提供具体收费、价格、平台支持范围与效果保证,这些信息暂未提供。指南需自包含,读者应仅凭代码库与指南即可理解。