企业官网建设流程全解析

适配 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层级（官方规则）

1. Project Skills（项目级）：.codebuddy/skills/，随Git提交，团队共享，优先级高于用户级Skill
2. User 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. 项目代码规范（从源码提取） - 统一返回实体 Result<T> 结构、错误码体系 - 全局异常处理规则 - 类、方法、URL、数据库字段命名规范 - 日志埋点、参数校验规则 - 自定义异常码清单 ### 7. 项目特殊逻辑 & 历史坑点 提取代码内隐性规则： 分布式锁Key规范、缓存更新策略、分布式事务方案、幂等处理、异步消息场景、分库分表； 所有注释 `注意/TODO/FIXME`；存在特殊分支判断的业务规则。 ## 第二部分：生成标准化Skill文件 ### SKILL.md 要求 1. 文件头部必须携带标准YAML frontmatter（name、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扫描生成

扫描耗时：2～5分钟，由项目代码量决定
输出顺序：先项目知识梳理 → 再输出整套Skill目录内所有文件。

📂 第三步：创建目录并落地文件（CodeBuddy标准路径）

执行命令创建官方标准目录：

mkdir-p.codebuddy/skills/my-project/mkdir-p.codebuddy/skills/my-project/references/

文件保存映射表（严格对齐官方目录）

AI输出文件名	项目存放路径
SKILL.md	.codebuddy/skills/my-project/SKILL.md
project-overview.md	.codebuddy/skills/my-project/references/project-overview.md
code-templates.md	.codebuddy/skills/my-project/references/code-templates.md
api-contracts.md	.codebuddy/skills/my-project/references/api-contracts.md
database-schema.md	.codebuddy/skills/my-project/references/database-schema.md
business-flows.md	.codebuddy/skills/my-project/references/business-flows.md
pitfalls.md	.codebuddy/skills/my-project/references/pitfalls.md

❗ 区分：Claude Code 使用.claude/skills，CodeBuddy 固定使用.codebuddy/skills，不要混淆

🎬 第四步：加载 & 验证Skill是否生效

两种调用方式（官方原生支持）

1. 自动触发（日常使用）
   AI根据SKILL.md中的description描述，自动识别场景加载Skill，无需手动操作。

2. 手动强制启用（推荐测试）
   两种方式任选其一：

• 方式A：对话框输入/唤起Skill选择菜单，选中my-project
• 方式B：直接斜杠命令调用

/my-project

测试指令

根据项目规范，帮我生成一个查询订单列表的接口

✅ 生效判断标准：
AI自动使用项目自定义Result<T>、遵守内部命名规范、复用项目表结构、规避pitfalls记录的历史问题。

管理入口：CodeBuddy 设置面板 → Skills；可以查看全部项目级/用户级Skill、支持导入导出。

---

📊 最终交付物价值清单

文件	定位（官方渐进式加载分工）	用途
SKILL.md	Skill核心入口，常驻上下文（精简）	AI自动加载，作为编码顶层指令，定义触发条件、基础规则
project-overview.md	references资源（按需加载）	新人快速上手项目文档
api-contracts.md	references资源（按需加载）	前后端接口对齐、接口查阅
database-schema.md	references资源（按需加载）	数据库设计文档、枚举查询
business-flows.md	references资源（按需加载）	需求评审、业务逻辑梳理
pitfalls.md	references资源（按需加载）	代码审查、新人避坑
code-templates.md	references资源（按需加载）	快速复用项目标准代码片段

官方设计原则再次强调：
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。

---

⚠️ 官方规范对应的重要注意事项

1. 敏感信息脱敏
   扫描前建议屏蔽配置文件数据库密钥、账号密码；可以追加指令：跳过application配置文件中的密钥、账号等敏感内容。

2. 首次生成需要人工微调
   AI自动产出无法100%覆盖隐性业务背景，生成后打开SKILL.md补充业务边界条件；后续持续迭代完善。

3. Skill元数据规范硬性标准（SKILL.md头部）
   必须携带YAML frontmatter示例，生成后检查：

---name:springboot-project-rulesdescription:当需要为当前SpringBoot项目编写接口、Service、数据库代码、修复bug、评审代码时启用，强制遵循项目统一返回格式、业务约束、历史避坑规则。allowed-tools:[]disable:false---# 正文...

name对应斜杠调用/springboot-project-rules；description决定AI自动触发匹配逻辑。

4. 资源目录区分（官方定义）

• 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 要求

1. 文件头部必须携带标准YAML frontmatter（name、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教程，只保留当前项目独有业务与规范
• 全面扫描核心接口、事务逻辑、特殊分支，不要遗漏关键业务规则
• 结构清晰，方便后续人工维护迭代

</details> 如果你需要，我可以额外生成一份**标准SKILL.md模板样板**，直接作为生成产物参考。