在Fitten_Code中如何利用AI生成项目README文档

Fitten Code可自动生成README：需v2.4.0+桌面端、登录并配置OpenAI/Claude密钥（保存后重启），右键项目根目录选“Generate README with AI”，或通过Ctrl+Shift+A/Cmd+U唤起AI对话框，支持聚焦单文件、引用全项目上下文、修补现有README三种方式，生成后须校验命令可执行性、Markdown渲染效果及链接有效性。

你刚写完一个新项目，代码已提交到仓库，但README.md还是空白——Fitten Code内置的AI文档生成器能直接基于项目结构和代码内容，自动生成带安装步骤、使用示例、技术栈说明的完整README，跳过手动拼凑的繁琐过程。

启用Fitten Code的AI README生成功能

打开Fitten Code桌面端（v2.4.0+），确保已登录账号并完成AI服务授权。未开启AI能力时，右下角状态栏会显示“AI未就绪”，点击后按指引绑定OpenAI或Claude API密钥，【必须保存密钥后重启编辑器】，否则后续所有AI操作均无法触发。

在项目根目录右键 → 选择“Generate README with AI” → 弹出窗口中确认当前工作区路径无误，点击“Start Analysis”。这一步会扫描.py/.js/.ts/.go等主语言文件、requirements.txt/package.json/pyproject.toml等配置文件，耗时约3–8秒，取决于项目规模。

用Chat模式精准控制生成内容

方法一：聚焦单个入口文件生成

在编辑区打开main.py或index.ts等主启动文件 → 按Ctrl+Shift+A（Windows）或Cmd+U（Mac）唤起AI对话框 → 输入：“基于当前文件逻辑与项目结构，生成中文README.md，重点突出CLI参数说明和错误处理机制”。

方法二：引用整个项目上下文

在对话框中输入#Folder → 等待右侧出现“Project context loaded”提示 → 再发送：“生成含‘快速开始’‘环境变量’‘测试命令’三节的README，忽略贡献指南”。【若未看到上下文加载成功提示，生成内容将严重缺失依赖信息】

方法三：修补已有README

打开现有README.md → 全选内容复制 → 在AI对话框粘贴后追加：“重写‘API接口’章节，从src/api/目录下所有TS文件中提取@GET/@POST路由及参数类型，用表格呈现”。

导出与验证生成结果

第一步：AI输出完成后，不要直接复制全文。先检查是否包含可执行命令——例如pip install -e .或npm run dev这类实际能跑通的指令，若出现pip install mypackage==1.0.0这种硬编码版本号，需手动改为pip install -e .或删除版本锁定。

第二步：点击右上角“Preview in Markdown”按钮，查看渲染效果。重点核对代码块语法高亮是否正确（如Python代码块应为```python，不是```py），链接是否指向项目内真实路径（如[配置说明](docs/config.md)不能写成[配置说明](./config.md)）。

第三步：将生成内容全选 → 粘贴到项目根目录下的README.md → 保存文件 → 在终端执行mdbook serve（如有docs/book.toml）或直接用浏览器打开README.md验证本地渲染效果。