CodeBuddy 针对技术文档编写的痛点，提供了一套高度自动化的解决方案，能够显著提升文档编写效率。它支持四种核心方式：第一种，基于 AST 与 JSDoc 自动生成组件 API 文档，让组件库的文档更新如同快捷键般便捷；第二种，通过 CLI 命令行批量生成项目级开发文档，适合梳理整体工程脉络；第三种，利用自然语言指令即时生成接口文档，后端开发者只需一句话即可获得初稿；第四种，调用 Skills 工具链将多个来源的信息融合为综合文档，特别适用于需要追溯版本历史的场景。
许多团队都在为技术文档的维护而烦恼——手动编写耗时费力、格式难以统一、内容容易遗漏。如果需要将代码、接口或项目结构快速转换为清晰可维护的 Markdown 文档，CodeBuddy 内置的几种机制可以直接上手。下面将详细拆解每个路径的实操流程。
一、基于源码分析自动生成组件API文档
这种方法的核心是利用 AST 静态解析与 JSDoc 注释提取能力。它能够从 .vue、.tsx 或 .ts 文件中精准识别出 props、emits、slots、类型定义，甚至自动提取代码示例片段，最终输出标准的 Markdown 格式文档。生成的文档天然适配 VuePress、Docusaurus 等静态站点生成器，堪称一步到位。
具体如何操作？来看实际流程。
1、在 CodeBuddy IDE 中打开你的前端组件库项目。前提是 src/components/ 目录下至少有一个组件文件（例如 Input.vue）已写好完整的 JSDoc 注释。这是基础，没有注释则难以开展。
2、点击顶部菜单栏的「Tools」，然后选择「Generate Component Docs」。这会启动 DocGen 扫描任务，自动遍历组件目录。
3、在弹出来的配置面板中，记得勾选两个重要选项：「Include TypeScript Interface Definitions」和「Auto-generate Live Demo Snippets」。前者保证类型定义被写入，后者能生成可交互的演示片段。
4、将输出路径设置为 docs/api/components/，然后点击「Run」。系统运行完成后，会生成 input.md、index.md 以及一份 components.json 元数据清单。这些文件可直接放入你的文档站点。
5、最后一步，检查生成的 input.md 文件。关键看是否包含类似 @param {string} variant - 输入框样式变体，支持 'default' | 'outline' | 'filled' 的参数说明。带类型标注的文档，才是开发人员真正需要的。
二、使用 CLI 指令批量生成项目级开发文档
面对整个工程目录时，逐个组件生成效率太低。此时可使用 CodeBuddy CLI 高效处理——它能自动遍历源码结构、梳理依赖关系、读取配置文件，最终生成面向二次开发者的集成式 Markdown 报告。这份报告包含模块职责、调用链路、环境变量说明等关键信息，相当于为项目绘制了一张完整的藏宝图。
1、在终端进入项目根目录，确认已安装 codebuddy-cli 并完成身份认证。这两步完成后才能继续。
2、执行核心指令：codebuddy doc --scope project --output docs/dev-guide.md。该命令的 scope 参数指定范围为项目级别，output 参数指定生成的目标文件。
3、等待 CLI 完成扫描。它会自动识别 src/、packages/、scripts/ 等目录，找到入口文件、构建脚本、核心 Hook 与 Service 层抽象。这个过程需耐心，因为数据量较大。
4、生成的 dev-guide.md 包含三大核心部分：「模块依赖图」、「环境变量对照表」、「本地调试步骤」。其中依赖图使用 Mermaid 语法内联渲染，可在支持 Mermaid 的工具中直接预览。
5、文档生成后，最好验证关键信息是否准确。例如，环境变量对照表中应清晰列出类似 REACT_APP_API_BASE_URL：生产环境 API 基础地址，默认值为空字符串，必须在 .env.production 中显式配置 的条目。这类信息的准确性直接决定了文档的实际价值。
三、通过自然语言指令即时生成接口对接文档
这种方式特别适合后端 API 快速交付的场景。无需提前配置复杂的文档框架，只需提供接口 URL、请求方法、入参结构和响应体样例，CodeBuddy 即可合成一份符合 OpenAPI 语义的 Markdown 接口文档。它对字段的必填性、枚举值、嵌套层级等细节都能准确还原。
1、在 CodeBuddy 聊天界面输入指令：/api-doc https://api.example.com/v1/users GET 用户列表查询接口。格式很直白：斜杠指令 + 接口地址 + 请求方法 + 中文描述。
2、系统会自动发起 OPTIONS 请求以获取响应头信息，同时提示你补充请求参数。此时需提供 query 参数的示例（例如 page=1&size=10）以及成功的响应 JSON 示例。
3、将响应体片段粘贴进去：
{ "data": [{ "id": 1, "name": "张三", "role": "admin" }], "total": 124 }
4、确认后，CodeBuddy 会输出完整的 Markdown 文档段落，包含「请求URL」、「请求方式」、「Query参数表格」、「响应字段说明表」以及「Curl调用示例」。基本上可直接复制到文档站点使用。
5、检查参数表格，重点看 role 字段是否被正确标注为枚举类型，取值范围是否为 'user' | 'admin' | 'guest'。这种细节的准确性正是自动化生成的价值所在。
四、调用 Skills 工具链实现多源文档融合生成
这是最强大的路径，适合复杂场景。它能整合企业知识库、架构图文件和 Git 提交历史，由多个 Skills 协同完成跨模态的信息抽取与结构化编排。最终输出的文档带有版本追溯和上下文注解，对理解项目的演进非常有帮助。
1、确保项目根目录下已存在 assets/architecture.png 和 CHANGELOG.md 文件。前者是架构图，后者是变更日志。
2、在 CodeBuddy 中执行斜杠指令：/doc-fusion --arch assets/architecture.png --changelog CHANGELOG.md --repo-history 3。注意最后参数 3 表示分析最近三次发布的提交记录。
3、系统会自动调用 image-analyzer 技能识别架构图中的服务边界和通信协议，同时同步解析 CHANGELOG.md 中最近的发布功能点。这个多技能协作过程几乎全自动。
4、接着调用 git-analyzer 技能，提取对应 commit 范围内的关键文件变更记录，例如 api/services/user.ts、config/auth.ts 等文件的具体改动。
5、最终生成 docs/fusion-overview.md 综合文档。在其中的「架构演进对比」章节，应能清楚看到类似 v2.3.0 新增 OAuth2.0 认证中间件，位于 auth/middleware.ts 第47–89行 的精准标注。这种级别的文档，对于新人上手或项目交接来说，价值不可估量。