codebuddy支持四类自动化文档生成：一、基于ast与jsdoc自动生成组件api文档；二、通过cli批量生成项目级开发文档；三、用自然语言指令即时生成接口文档；四、调用skills工具链融合多源信息生成综合文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您希望借助 CodeBuddy 快速将代码、接口或项目结构转化为结构清晰、可维护的 Markdown 文档，但面临手动编写耗时、格式不统一、内容易遗漏等问题，则可通过多种内置机制实现技术文档的自动化生成。以下是具体实施路径：
一、基于源码分析自动生成组件API文档
该方式利用 AST 静态解析与 JSDoc 注释提取能力，从 .vue、.tsx 或 .ts 文件中识别 props、emits、slots、类型定义及示例片段，输出标准 Markdown 格式文档，适配 VuePress、Docusaurus 等静态站点生成器。
1、在 CodeBuddy IDE 中打开前端组件库项目，确保 src/components/ 目录下存在至少一个含完整 JSDoc 的组件文件（如 Input.vue）。
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。
3、等待 CLI 完成对 src/、packages/、scripts/ 等目录的扫描，自动识别入口文件、构建脚本、核心 Hook 与 Service 层抽象。
4、生成的 dev-guide.md 将包含「模块依赖图」、「环境变量对照表」、「本地调试步骤」三大部分，其中依赖图采用 Mermaid 语法内联渲染。
5、验证文档中是否准确列出 REACT_APP_API_BASE_URL：生产环境 API 基础地址，默认值为空字符串，必须在 .env.production 中显式配置。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手，支持自然语言驱动开发。 - 必备触发词：CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景：安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
三、通过自然语言指令即时生成接口对接文档
该方式适用于后端 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、系统自动调用 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行。
