应通过craft模式生成结构化readme，结合docs知识库增强专业性，用chat模式补充关键细节，并借助mcp协议接入自定义模板以确保规范统一。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您需要为CodeBuddy生成的项目快速构建规范、可读性强的README和开发文档，但发现内容空洞、结构混乱或技术细节缺失，则可能是由于文档生成时未充分注入项目上下文或未指定输出粒度。以下是解决此问题的步骤：
一、使用Craft模式精准生成README
Craft模式支持将自然语言需求直接映射为结构化文档，其核心在于主动引导AI理解项目边界与交付目标。该模式会自动提取已生成代码中的模块划分、依赖关系及入口点，并据此组织文档层级。
1、在CodeBuddy IDE中切换至Craft模式。
2、输入明确指令：“基于当前项目代码，生成一份符合开源标准的README.md，包含：项目简介、技术栈、快速启动步骤（含命令）、环境变量说明、API端点列表（如有）”。
3、等待模型完成多轮上下文分析后，点击“生成文档”按钮获取Markdown源码。
4、将生成内容粘贴至项目根目录下的README.md文件并保存。
二、调用Docs知识库增强开发文档专业性
Docs知识库内置了Spring Boot、Vue、微信小程序等主流技术栈的官方文档结构范式，启用后可使生成文档自动对齐行业通用术语与章节逻辑，避免出现“功能描述模糊”或“部署步骤跳步”等问题。
1、点击IDE左下角Docs图标打开知识库面板。
2、在搜索框中输入当前项目所用框架名称，例如“Vue 3 Composition API”。
3、勾选对应技术文档条目，确保其状态显示为“已激活”。
4、返回Craft模式，再次提交相同README生成请求，系统将融合知识库元数据输出更严谨的表述。
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 问题
三、通过Chat模式人工校验与迭代补充
Chat模式提供细粒度对话控制能力，适用于修复自动生成文档中遗漏的关键信息，如私有NPM源配置、CI/CD流水线触发条件或本地调试代理设置等非标准但必需的内容。
1、切换至Chat模式，上传当前项目package.json和.env.example文件。
2、发送指令：“请检查刚才生成的README，补充缺失的‘私有依赖安装’说明，并为.env.example中每个变量添加中文注释”。
3、逐条核对AI返回的修订建议，确认无误后执行替换操作。
4、将修订后的内容复制进README.md对应位置。
四、利用MCP协议接入外部文档模板
MCP（Model Control Protocol）允许用户挂载自定义文档模板，适用于团队统一风格要求场景。该方式绕过默认生成逻辑，直接注入预设结构，确保标题层级、代码块格式、链接样式完全可控。
1、准备一个本地Markdown模板文件，命名为template-internal.md，其中包含占位符如{{PROJECT_NAME}}、{{TECH_STACK}}。
2、在Craft模式中点击“高级设置”→“导入MCP模板”，选择该文件。
3、在指令中声明：“使用已导入的内部模板生成README，将PROJECT_NAME替换为‘PetEcom-Vue’，TECH_STACK替换为‘Vue 3 + Pinia + Axios’”。
4、执行生成，结果将严格遵循模板定义的段落顺序与样式规范。
