适配 CodeBuddy 官方Skill规范 · 优化完整版教程完全对齐 CodeBuddy Skill 官方文档目录结构、渐进式披露原则、SKILL.md YAML元数据、三级加载机制、项目/用户Skill优先级、斜杠手动触发规则删除原文中Claude Code冗余路径混淆点强化「渐进式加载」设计思想修正部署路径、Skill调用方式、文件规范适配官方标准。 前言资深后端程序员的痛点作为长期维护大型 Spring Boot 项目的开发者你大概率会遇到这些痛点接手老旧项目梳理Controller、数据表、业务流转、历史坑点耗时数日AI生成代码永远是通用模板不遵循项目自有规范统一返回体、异常体系、状态机、缓存规则项目隐性约束、历史踩坑经验只掌握在老员工脑中新人、AI反复踩相同问题CodeBuddy Skill 是模块化、自包含的能力包可以把通用AI转为适配你项目的专属开发专家。我们可以一次性扫描项目自动生成一套符合官方标准的项目知识库 完整Skill包让AI写代码天然遵守项目规范。设计思想贴合官方【渐进式披露原则】SKILL.md常驻轻量元数据核心指令 references按需加载详细文档避免上下文过载。 准备工作项目说明✅ Java / Spring Boot 项目任意规模Maven/Gradle均可✅ IDEA CodeBuddy 插件已安装具备读取项目源码权限安装方式IDEA插件市场搜索CodeBuddy完成安装。区分两个Skill层级官方规则Project Skills项目级.codebuddy/skills/随Git提交团队共享优先级高于用户级SkillUser Skills用户级本机全局所有项目生效适合个人通用规范 第一步发送扫描生成Prompt直接复制将下面完整提示词粘贴至CodeBuddy对话框执行。该Prompt强制遵循CodeBuddy Skill目录规范、三级加载机制产出物符合官方标准。请全面扫描当前Spring Boot项目源码生成一套符合CodeBuddy官方规范的完整项目知识库 Skill能力包。 严格遵循CodeBuddy Skill规范 1. Skill根目录my-project 2. 必须包含带YAML frontmatter的SKILL.md核心入口 3. 详细文档统一放入 references/禁止大量内容堆砌在SKILL.md 4. 遵循渐进式披露原则SKILL.md精简详细资料作为按需加载资源 ## 第一部分项目知识梳理优先输出 结构化整理以下项目特有信息仅保留项目自定义逻辑剔除SpringBoot、Mybatis通用基础知识点 ### 1. 项目概览 - 项目名称、业务定位 - 精准技术栈清单框架版本、数据库、中间件、核心依赖 - 项目分层架构、模块依赖关系 ### 2. 核心业务模块清单 - 全部业务模块order/user/payment等 - 各模块职责、模块间调用关系 ### 3. 核心数据表清单 - 核心业务表用途 - 表关联关系外键、关联字段 - 关键字段、状态枚举、类型枚举释义 ### 4. Controller 接口清单 - 所有Controller基础路径 - 接口请求方式、URL、入参、返回体 - 标记权限接口、幂等接口、限流、异步接口 ### 5. Service 核心业务逻辑 - 核心Service职责 - 复杂逻辑标记事务、状态机、分布式锁、消息队列、重试逻辑 - 关键业务流程支持Mermaid流程图 ### 6. 项目代码规范从源码提取 - 统一返回实体 ResultT 结构、错误码体系 - 全局异常处理规则 - 类、方法、URL、数据库字段命名规范 - 日志埋点、参数校验规则 - 自定义异常码清单 ### 7. 项目特殊逻辑 历史坑点 提取代码内隐性规则 分布式锁Key规范、缓存更新策略、分布式事务方案、幂等处理、异步消息场景、分库分表 所有注释 注意/TODO/FIXME存在特殊分支判断的业务规则。 ## 第二部分生成标准化Skill文件 ### SKILL.md 要求 1. 文件头部必须携带标准YAML frontmattername、description必填 2. 正文控制在400行以内 3. 写明Skill触发场景、核心工作流、项目规则速查表 4. 长文档全部引用 references/ 下文件禁止大段文本 ### references/ 需要产出文件清单 - project-overview.md第一部分全部项目梳理内容 - code-templates.md项目通用代码模板 - api-contracts.md接口完整文档 - database-schema.md数据表、字段、枚举说明 - business-flows.md业务流程支持Mermaid - pitfalls.md项目避坑清单 ## 输出格式硬性要求 1. 先输出【项目知识梳理】再输出【Skill全套文件】 2. 使用 文件名 分割每个独立文件 3. 所有代码、文档使用 markdown / java 代码块包裹 ## 重要约束 - 不输出通用Java/Spring教程只保留当前项目独有业务与规范 - 全面扫描核心接口、事务逻辑、特殊分支不要遗漏关键业务规则 - 结构清晰方便后续人工维护迭代⏳ 第二步等待AI扫描生成扫描耗时25分钟由项目代码量决定输出顺序先项目知识梳理 → 再输出整套Skill目录内所有文件。 第三步创建目录并落地文件CodeBuddy标准路径执行命令创建官方标准目录mkdir-p.codebuddy/skills/my-project/mkdir-p.codebuddy/skills/my-project/references/文件保存映射表严格对齐官方目录AI输出文件名项目存放路径SKILL.md.codebuddy/skills/my-project/SKILL.mdproject-overview.md.codebuddy/skills/my-project/references/project-overview.mdcode-templates.md.codebuddy/skills/my-project/references/code-templates.mdapi-contracts.md.codebuddy/skills/my-project/references/api-contracts.mddatabase-schema.md.codebuddy/skills/my-project/references/database-schema.mdbusiness-flows.md.codebuddy/skills/my-project/references/business-flows.mdpitfalls.md.codebuddy/skills/my-project/references/pitfalls.md❗ 区分Claude Code 使用.claude/skillsCodeBuddy 固定使用.codebuddy/skills不要混淆 第四步加载 验证Skill是否生效两种调用方式官方原生支持自动触发日常使用AI根据SKILL.md中的description描述自动识别场景加载Skill无需手动操作。手动强制启用推荐测试两种方式任选其一方式A对话框输入/唤起Skill选择菜单选中my-project方式B直接斜杠命令调用/my-project测试指令根据项目规范帮我生成一个查询订单列表的接口✅ 生效判断标准AI自动使用项目自定义ResultT、遵守内部命名规范、复用项目表结构、规避pitfalls记录的历史问题。管理入口CodeBuddy 设置面板 → Skills可以查看全部项目级/用户级Skill、支持导入导出。 最终交付物价值清单文件定位官方渐进式加载分工用途SKILL.mdSkill核心入口常驻上下文精简AI自动加载作为编码顶层指令定义触发条件、基础规则project-overview.mdreferences资源按需加载新人快速上手项目文档api-contracts.mdreferences资源按需加载前后端接口对齐、接口查阅database-schema.mdreferences资源按需加载数据库设计文档、枚举查询business-flows.mdreferences资源按需加载需求评审、业务逻辑梳理pitfalls.mdreferences资源按需加载代码审查、新人避坑code-templates.mdreferences资源按需加载快速复用项目标准代码片段官方设计原则再次强调SKILL.md 指令手册精简references 百科文档详细严禁双向重复内容 进阶实操技巧技巧1超大项目拆分扫描避免上下文溢出第一步仅扫描输出【项目概览业务模块清单】 第二步输出【数据表清单Controller接口清单】 第三步最后生成完整Skill整套文件技巧2持续迭代更新Skill长期维护方案当发现AI持续出现同类错误直接追加指令更新文档你在生成订单取消逻辑时缺少【待支付状态校验】规则请将这条约束补充到 references/pitfalls.md同时同步更新SKILL.md核心规则速查表。技巧3业务流程图增强在主Prompt追加一行在 business-flows.md 中使用 Mermaid 语法绘制核心业务流程图。技巧4团队共享.codebuddy/skills/纳入Git版本管理团队所有成员拉取代码后CodeBuddy自动识别项目级Skill。⚠️ 官方规范对应的重要注意事项敏感信息脱敏扫描前建议屏蔽配置文件数据库密钥、账号密码可以追加指令跳过application配置文件中的密钥、账号等敏感内容。首次生成需要人工微调AI自动产出无法100%覆盖隐性业务背景生成后打开SKILL.md补充业务边界条件后续持续迭代完善。Skill元数据规范硬性标准SKILL.md头部必须携带YAML frontmatter示例生成后检查---name:springboot-project-rulesdescription:当需要为当前SpringBoot项目编写接口、Service、数据库代码、修复bug、评审代码时启用强制遵循项目统一返回格式、业务约束、历史避坑规则。allowed-tools:[]disable:false---# 正文...name对应斜杠调用/springboot-project-rulesdescription决定AI自动触发匹配逻辑。资源目录区分官方定义references业务文档、架构说明给AI阅读参考scripts可执行脚本本场景暂不需要assets模板文件、静态资源输出产物使用 总结优化对比使用前使用Skill方案后AI输出通用代码不符合项目规范AI原生遵循项目返回体、异常、业务规则项目文档零散、长期没人维护AI持续维护一套可同步Git的知识库隐性业务坑只掌握在老员工pitfalls文档沉淀所有历史问题每次对话反复重复项目约束Skill自动加载无需重复说明规范依托CodeBuddy原生Skill机制让AI成为深度理解你业务代码的专属开发助手。 附录一键复制完整版Prompt点击展开完整Prompt已适配CodeBuddy官方Skill标准 markdown 请全面扫描当前Spring Boot项目源码生成一套符合CodeBuddy官方规范的完整项目知识库 Skill能力包。 严格遵循CodeBuddy Skill规范 1. Skill根目录my-project 2. 必须包含带YAML frontmatter的SKILL.md核心入口 3. 详细文档统一放入 references/禁止大量内容堆砌在SKILL.md 4. 遵循渐进式披露原则SKILL.md精简详细资料作为按需加载资源第一部分项目知识梳理优先输出结构化整理以下项目特有信息仅保留项目自定义逻辑剔除SpringBoot、Mybatis通用基础知识点1. 项目概览项目名称、业务定位精准技术栈清单框架版本、数据库、中间件、核心依赖项目分层架构、模块依赖关系2. 核心业务模块清单全部业务模块order/user/payment等各模块职责、模块间调用关系3. 核心数据表清单核心业务表用途表关联关系外键、关联字段关键字段、状态枚举、类型枚举释义4. Controller 接口清单所有Controller基础路径接口请求方式、URL、入参、返回体标记权限接口、幂等接口、限流、异步接口5. Service 核心业务逻辑核心Service职责复杂逻辑标记事务、状态机、分布式锁、消息队列、重试逻辑关键业务流程支持Mermaid流程图6. 项目代码规范从源码提取统一返回实体 Result 结构、错误码体系全局异常处理规则类、方法、URL、数据库字段命名规范日志埋点、参数校验规则自定义异常码清单7. 项目特殊逻辑 历史坑点提取代码内隐性规则分布式锁Key规范、缓存更新策略、分布式事务方案、幂等处理、异步消息场景、分库分表所有注释注意/TODO/FIXME存在特殊分支判断的业务规则。第二部分生成标准化Skill文件SKILL.md 要求文件头部必须携带标准YAML frontmattername、description必填正文控制在400行以内写明Skill触发场景、核心工作流、项目规则速查表长文档全部引用 references/ 下文件禁止大段文本references/ 需要产出文件清单project-overview.md第一部分全部项目梳理内容code-templates.md项目通用代码模板api-contracts.md接口完整文档database-schema.md数据表、字段、枚举说明business-flows.md业务流程支持Mermaidpitfalls.md项目避坑清单输出格式硬性要求先输出【项目知识梳理】再输出【Skill全套文件】使用 文件名 分割每个独立文件所有代码、文档使用markdown /java 代码块包裹重要约束不输出通用Java/Spring教程只保留当前项目独有业务与规范全面扫描核心接口、事务逻辑、特殊分支不要遗漏关键业务规则结构清晰方便后续人工维护迭代/details 如果你需要我可以额外生成一份**标准SKILL.md模板样板**直接作为生成产物参考。