Trae支持三种README生成模式:①Builder模式用于新项目,依自然语言描述自动生成标准结构及中文README;②Chat模式基于真实代码重写README,需用#Folder标签确保完整上下文扫描;③“产品设计”智能体生成PRD与运维向README-SYS.md双文档。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

要用Trae自动生成专业、结构完整的项目说明文档README.md,必须匹配当前项目真实代码结构与运行逻辑,不能靠空想描述生成。
用Builder模式从零生成带结构的README
该模式适合新项目初始化阶段,AI根据你一句话描述推断技术栈、功能边界和目录规范,同步创建文件结构与配套文档。
在Trae右侧AI交互区点击模式切换按钮→选择【Builder】→输入类似“开发一个基于React+Vite的待办清单Web应用,支持本地存储、任务分类与完成统计,生成标准项目结构及中文README.md”的自然语言需求。
点击“运行”后,Trae会自动创建src、public、components等目录,生成vite.config.ts、package.json,并【在项目根目录下直接写出README.md文件,内容含标题、简介、安装命令、启动方式、功能说明、技术栈列表】。
生成的README不含具体API细节或环境变量说明——因为此时代码尚未编写,AI仅基于描述做合理推演。若后续添加了.env或API调用,需进入Chat模式补充。
用Chat模式基于真实代码重写README
当项目已有入口文件(如main.ts、app.py或index.js),且逻辑已初步跑通时,此模式能精准提取依赖、路由、配置项,输出可直接替换原README的专业文本。
方法一:快捷唤起分析
在代码编辑区打开主入口文件→按Ctrl+Shift+A(Windows)或Cmd+U(Mac)唤出Chat窗口→输入:“基于当前项目结构和全部代码逻辑,重写一份专业级中文README.md”。
方法二:强制引用完整上下文
在相同Chat输入框中,末尾追加#Folder标签→这会让AI扫描整个项目目录树,包括package.json、requirements.txt、.env.example、src/router/index.ts等关键文件。
【务必确保#Folder前有空格,否则AI无法识别为指令;若漏掉,生成的README将缺少依赖版本和环境变量说明】
AI返回结果后,全选→复制→打开项目根目录下的README.md→粘贴覆盖→保存。这一步操作起来很简单,直接把文本拖进去就行。
调用“产品设计”智能体生成系统级文档
适用于需对外交付、含多模块协作或要嵌入CI/CD流程的中大型项目,输出内容偏向运维视角与架构说明,不替代基础README,而是作为其增强附件。
第一步:启用智能体
进入Trae左下角设置图标→智能体管理→找到“产品设计”智能体→点击启用开关。
第二步:触发双文档生成
在任意Chat窗口输入:“请为当前项目生成《产品需求文档(PRD)》与《README系统说明文档》”,并在句末添加#Workspace。
第三步:分离使用
AI将输出两段独立Markdown文本:PRD含用户角色、核心流程图、非功能约束;README系统说明文档则聚焦部署拓扑、健康检查端点、日志路径、升级回滚步骤等运维必需信息。
把第二段内容单独复制,另存为README-SYS.md,和主README.md并列放在根目录即可。不需要合并,也不建议覆盖原始README。

















