WorkBuddy可一键解析React项目源码生成标准README：自动提取项目名、功能、依赖等基础信息；支持Git元数据注入补全版本与仓库链接；绑定JSDoc注释生成接口与组件说明表格。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要为刚完成的 React 项目快速生成一份结构完整、字段准确、带语法高亮和超链接的 README.md 文档，避免手动整理功能说明、依赖列表、启动命令等信息时遗漏关键项或版本错位。
用WorkBuddy一键解析源码生成基础README
该方法适用于尚未初始化 Git 仓库、也未编写任何注释的裸项目，依赖 WorkBuddy 的本地 AST 解析能力直接读取源文件语义。
1、将项目根目录（例如 【D:\Projects\MyReactApp】）确保可被本地磁盘访问，且不包含中文路径或空格；
2、在 WorkBuddy 主界面点击「新建任务」，输入指令：请基于 D:\Projects\MyReactApp 项目，提取项目名称、核心功能、编程语言、最低运行环境、依赖列表、启动命令、API端点示例及作者信息，生成标准 Markdown 格式 README 文档；
3、确认 AI 自动排除了 node_modules、.git、dist 等非源码目录后，点击执行；系统将在沙箱中扫描 package.json、src/index.js、src/App.js 等入口文件，聚合出结构化元数据骨架。
这一步操作起来很简单，直接把文件拖进去就行。但注意：若 package.json 中 name 字段为空或为默认值 create-react-app，AI 将无法推断真实项目名，需提前手动修正。
注入 Git 元数据补全版本与地址信息
该方法必须在项目已执行过 git init、至少一次 commit 且配置了 origin 远程仓库的前提下使用，否则生成的 Badge 和链接将失效。
方法一：追加指令注入
在上一步任务指令末尾直接添加：同步读取该仓库的 Git 元数据，将最新 tag 作为版本号填入 Badge，将 origin URL 填入“源码地址”章节，将最近 3 条 commit 摘要整合为“更新日志”子章节。
使用 draw.io（.drawio 格式）和 SVG 生成兼容 Microsoft Visio 的架构图。当用户需要以下任一场景时触发： - 用于 Visio 或技术文档的架构/系统/网络图 - 带连接标注的分层控制系统图 - 将 draw.io XML 转换为稳定、可嵌入的 SVG - 修复 Visio 或 draw.io 无法打开的故障排查类图表 - 任何需专业级布局且文本可编辑的图表
方法二：手动校验关键字段
执行后立即检查生成文档中 [](https://github.com/user/repo) 是否渲染成功，并用终端运行 git remote get-url origin 对比 URL 是否完全一致——【URL 必须一字不差，包括 .git 后缀】。
绑定代码注释自动填充接口与函数说明
如果你已在组件或 API 文件中写了规范 JSDoc，这步能让 README 的 “核心功能” 和 “使用示例” 章节真正具备可执行参考价值。
第一步：在 WorkBuddy 任务中启用注释绑定
输入指令时明确声明：请提取 src/components/Calculator.jsx 和 src/api/fetchCocktail.js 中所有带 @param、@returns、@example 标签的 JSDoc 注释，转换为 “组件 Props” 和 “API 调用示例” 表格。
第二步：验证注释覆盖率
AI 仅解析被显式标注为 public 或 export 的函数/类；若 Calculator 组件是默认导出但未写 @public，或 fetchCocktail 函数被包裹在闭包内未暴露，这些内容将不会出现在文档中。
第三步：插入生成结果
生成完成后，复制粘贴到 README 的 ## API 接口说明 或 ## 组件使用 章节下即可，无需二次编辑格式。
