# trae-docs-tutorial

**Repository Path**: daitougege/trae-tutorial

## Basic Information

- **Project Name**: trae-docs-tutorial
- **Description**: trae 需求文档编写示例
- **Primary Language**: HTML
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-31
- **Last Updated**: 2026-08-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## trae  项目需求编写指导
**本篇主要针对非代码开发者用户，或者说已经不关心项目代码是如何编写的用户**   
###  概述

为了方便用户更快速上手使用 `trae` 快速开发项目，因此编写本文档，辅助用户基于 `trae` 快速开发项目。

### 快速上手

### 一、编写需求文档
首先想清楚你的需求是什么，按照2层结构组织需求文档，编写清晰的需求文档。
尽可能不要使用3层结构，避免层级太深，导致需求文档链接被遗漏。  
总之，作为一名需求提出方，你能够编写专业的需求文档(文档组织结构清晰、需求明确、细节表达精准，模式闭环)，你的任务就出色的完成了。

[点击查看需求示例](./项目需求/项目需求说明.md)

###  本次的需求文档结构如下
 -  以一个中型项目的的结构组织需求文档如下，如果是小型项目只需要将全部需求写在一个文档即可。   
```code
项目需求说明.md
   |—— 第一章
         |—— chapt1.md
   |—— 第二章
         |—— chapt2.md
```

###  trae  如何执行任务

创建空白文件夹，将本次的需求文档结构全部直接复制到该文件夹中，`trae`  打开该文件夹。
在当前文件夹下创建 `AGENTS.md` 文件，该文件的主要作用是将项目需求、设计、开发、测试、交付等各个阶段，按照什么顺序、什么规则执行规划清楚，确保任务的执行先后顺序、预期目标全部实现，确保不遗漏任何环节。  
关于  `AGENTS.md` 文件，`trae` 官方的介绍：  
> AGENTS.md 通常放在项目根目录，用于向 AI 智能体提供当前项目的行为指引,它适合写项目专属规范，例如目录说明、开发命令、测试要求、分支策略和注意事项。
> AGENTS.md 更像“项目说明书”，只服务当前项目,相比全局规则，它更适合写那些不应该影响其他项目的要求。


**注意：任何一个独立阶段文档，也可以在 `AGENTS.md` 文件中直接编写一个闭环的执行流程**。

以下是  AGENTS.md 文件的内容：    
```code
###  目标一：业务需求
一、请根据当前目录下的入口文件 `项目需求>项目需求说明.md` 中的需求(包含关联章节的所有需求清单)，完成本项目的任务。

// 后面的目标属于示例，本次任务只有目标一(业务需求)
###  目标二：设计任务(界面等)
二、请根据项目需求，设计项目的界面，包括但不限于：
- 登录页
- 主页面

###  目标三：开发任务
定义开发的前后端技术栈、技术架构、数据库等。

###  目标四：测试任务
定义测试的场景、测试用例、测试工具等。

###  目标五：交付标准
定义项目的交付标准，包括但不限于：
- 代码质量、代码规范、代码注释等。


```
### 距离 trae 真正执行任务还有一步  
- `trae solo/work` 模式下，在对话框中输入以下命令确保需求在执行前经过了AI的检查和人工二次确认： 
```code
# 输入命令  `/plan` 或者  `/spec`  
`/plan` 
# 然后输入如下提示词语(供参考)
请阅读本项目需求，确保项目需求清单您已经全部知晓，并给出阅读后的需求清单，让我确认执行计划，才能进行下一步。
作为数据采集专家，您认为现在的 `项目需求>项目需求说明.md` 文档文档还需要进行哪些优化？

// 需求过程时，trae 会的右侧弹出完善后的需求清单，您可以直接修改、或者直接确认。
// 等待 `trae` 阅读需求、双方确认细节，二次确认后真正执行任务。
```


###  trae 完成任务后的效果图
![trae 完成任务后的效果图](./result.png)