Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 4.2 KB

File metadata and controls

46 lines (38 loc) · 4.2 KB

帮我创建一个新的 skill。

我的需求如下:

  • Skill 想解决的问题: 让 大模型 完整通读整个大型项目的全部源码,在充分理解模块间依赖和调用关系后,生成项目导航阅读路线readme文件,再基于全局批量为每行代码上方添加高质量的“意图级”注释,辅助快速读懂陌生 / 自有项目,使得新人拿到项目后,浏览代码如同看一本带“批注”和“地图”的实体书

  • 典型触发场景(至少 3 条): 场景 A(全量填充):“帮我通读这个个项目,给所有核心业务模块加上中文业务注释,注释风格参考 Spring 实战。” 场景 B(定向攻坚):“帮我把 payment 包下所有类深度注释一遍,重点是梳理清楚状态机的流转逻辑,其他包先不管。” 场景 C(更新维护):“我刚刚合并了 feature/refactor 分支,帮我把这次变更涉及到的 20 个文件的注释全部更新同步。” 场景 D(链路追踪):“帮我追踪一下 用户下单 这个接口,从 Controller 到数据库的完整调用链,并在关键节点(如事务、RPC调用)加上业务意图注释。”

  • 明确不该触发的场景(至少 2 条): 拒绝场景 1(纯算法题):“请为我解释这段 LeetCode 回溯算法的每一行。” 判定规则:不存在完整项目目录、不存在多文件依赖关系,仅单段独立代码,无工程上下文,不需要构建项目图谱,禁止启动本 Skill,应走普通问答。 拒绝场景 2(代码重构):“帮我把这个前端项目重构成xxx框架。” 判定规则:需求目标是修改代码结构、调整业务实现,不聚焦注释生成与项目阅读导航,不属于本 Skill 边界,应走普通问答。 拒绝场景 3(故障急救):“我的项目启动报错 BeanCreationException / ModuleNotFoundError,帮我改一下代码让它能运行起来。” 判定规则:这是诊断与修复任务,需变更代码逻辑和依赖,而非添加说明性注释,拒绝执行。Skill 可以建议“请先运行调试技能”但绝不自行修改纠错逻辑。 拒绝场景 4(无项目结构): "帮我写个带注释的爬虫脚本。" 判定规则:单文件或无标准项目结构(无 pom.xml / build.gradle / package.json / go.mod等),不具备"通读项目"的前提,禁止启动。 拒绝场景 5(无): "帮我对比一下这几个项目"

  • 期望输出: 1.生成结构化项目导航文档ZHIDAO.md:技术栈识别、目录树、模块职责、依赖流向、推荐阅读路径 2.分层代码讲解:从入口→核心业务→底层工具逐层解析; 3.可直接使用的代码注释(支持类 / 方法注释,兼容 Java/Python/ 前端主流注释规范,不覆盖已有有效注释);

  • 是否需要脚本支持: 【是】(必须有,且职责重大)。 因为 LLM 上下文窗口装不下完整大项目。配套脚本(Python/Node)需要做 “分层摘要蒸馏”: 1.提取骨架:遍历所有源文件,提取类名、方法签名、Import 列表,构建出全仓库的调用关系 JSON(不含具体实现代码)。 2.分片投喂:将这个大 JSON 和项目 README 作为“全局上下文”先喂给 LLM,让 LLM 决策“哪个类最重要,应该优先注释”。 3.精准捞取:根据 LLM 的优先级排序,脚本将对应类的完整源码逐批取出,再喂给 LLM 生成详细注释,写入文件。 4.变更检测:利用 Git Diff 识别哪些文件发生了变动,只对这些文件重新跑注释生成(避免重复全量扫描)

  • 是否需要 references(详细参考资料): [是]

  • 额外约束: 1.优先区分全项目通读模式和局部模块精读模式,按需切换; 2.生成注释遵循「业务意图优先」,拒绝无意义流水账注释; 3.先输出项目整体导航,再进入代码注释环节,遵循 “先宏观后微观” 阅读顺序; 4.遇到超大项目,支持分阶段分批解析,避免一次性信息过载; 5.识别配置文件、文档、静态资源、测试代码,跳过这些文件;