ShaoHua
8b0b2cb197
- 新增 08-AI沟通记录规范.md，约定沟通记录存储结构与生命周期 - 新增 docs/AI沟通记录/ 目录及首批沟通记录 - 删除已迁移的旧规则文件 commenting.md、documentation_sync.md - 更新索引与智能体记忆文件
76 lines
4.8 KiB
Markdown
76 lines
4.8 KiB
Markdown
# .trae 目录索引
|
||
|
||
> 本文件是 `.trae/` 目录的总入口，描述各子目录与关键文件的职责，便于智能体与开发者快速定位。
|
||
>
|
||
> 关于 TRAE 官方"全局规则 vs 项目规则"：TRAE IDE 的"全局规则"由设置中心保存到用户级、**不入仓**；本仓库 `.trae/rules/` 下的所有内容（含子目录）都会被 TRAE 识别为**项目规则**。下面的子目录 `全局/` 与 `项目/` 是项目内部的**语义分组**，不改变 TRAE 的加载语义。
|
||
>
|
||
> 子目录嵌套深度受 TRAE 官方限制：`.trae/rules/` 下最多 3 层嵌套。
|
||
>
|
||
> 文件命名约定：每个子目录内文件以 `NN-名称.md` 格式编号（两位数字），编号反映**阅读优先级 / 依赖顺序**。索引文件本身不带序号。
|
||
>
|
||
> ⚠️ **新增文件必须遵守命名规则**：序号 = 当前目录最大值 + 1，不得跳号或重复，并需同步更新本索引文件中的对应章节。详见 [01-智能体记忆.md](./rules/全局/01-智能体记忆.md#文件命名规则强制)。
|
||
>
|
||
> ⚠️ **任务完成后清理义务**：研发工单验收完成后，必须清理 `coordination/` 中的临时记录行（保留文件与表头），并按需追加 `memory/` 的长期记忆条目。详见 [07-并行窗口冲突规约.md](./rules/全局/07-并行窗口冲突规约.md#任务验收后-coordination-清理) 与 [02-记忆存储规范.md](./rules/全局/02-记忆存储规范.md#memory-生命周期)。
|
||
|
||
---
|
||
|
||
## 整体结构
|
||
|
||
```
|
||
.trae/
|
||
├── 索引.md ← 本文件（目录入口）
|
||
├── rules/
|
||
│ ├── 全局/ ← 通用规范（跨项目可复用的方法论）
|
||
│ └── 项目/ ← Hua.Todo 专属（业务/架构/状态/数据）
|
||
├── memory/ ← 长期记忆数据（决策、对话产物）
|
||
└── coordination/ ← 多 solo 窗口协作目录（运行时登记表）
|
||
```
|
||
|
||
---
|
||
|
||
## rules/全局/ — 通用规范（与具体项目无关）
|
||
|
||
| 文件 | 职责 |
|
||
|---|---|
|
||
| [01-智能体记忆.md](./rules/全局/01-智能体记忆.md) | 智能体记忆/规范同步机制（**不含目录总览，由本索引文件承担**） |
|
||
| [02-记忆存储规范.md](./rules/全局/02-记忆存储规范.md) | `.trae/memory/` 的使用方式 |
|
||
| [03-注释规范.md](./rules/全局/03-注释规范.md) | C# / TypeScript / Vue 代码注释要求 |
|
||
| [04-文档同步规范.md](./rules/全局/04-文档同步规范.md) | 代码变更同步 README/docs 的硬性要求 |
|
||
| [05-研发工单规则.md](./rules/全局/05-研发工单规则.md) | 研发工单术语与边界（编码工作项 vs Todo 待办项） |
|
||
| [06-研发工单拆分规范.md](./rules/全局/06-研发工单拆分规范.md) | 工单拆分目录与文件结构 |
|
||
| [07-并行窗口冲突规约.md](./rules/全局/07-并行窗口冲突规约.md) | 并行 solo 窗口下的 Touch List / Writer / 绿线策略 |
|
||
| [08-AI沟通记录规范.md](./rules/全局/08-AI沟通记录规范.md) | 用户与智能体沟通记录的存储目录、序号管理与内容规范 |
|
||
|
||
---
|
||
|
||
## rules/项目/ — Hua.Todo 专属
|
||
|
||
| 文件 | 职责 |
|
||
|---|---|
|
||
| [01-项目架构.md](./rules/项目/01-项目架构.md) | src/ 五大项目划分、依赖方向、两种运行模式 |
|
||
| [02-业务命名规范.md](./rules/项目/02-业务命名规范.md) | `Task`/`SubTask`/`TaskEntity` 等代码标识符与"研发工单"边界 |
|
||
| [03-数据模型与迁移约束.md](./rules/项目/03-数据模型与迁移约束.md) | EF Core 实体清单、迁移历史、改 schema 纪律 |
|
||
| [04-即时状态记忆.md](./rules/项目/04-即时状态记忆.md) | 当前活跃版本 / 工单状态快照 / 临时决策 / 未完结事项 |
|
||
|
||
---
|
||
|
||
## memory/ — 长期记忆
|
||
|
||
- 用途：长期沉淀的对话产物、关键开发决策、不再频繁更新的项目快照
|
||
- 与"项目即时状态"的边界：[04-即时状态记忆.md](./rules/项目/04-即时状态记忆.md) 偏当前快照、更新频率高；`memory/` 偏长期保留
|
||
- 维护规约：详见 [02-记忆存储规范.md](./rules/全局/02-记忆存储规范.md)
|
||
- 文件：
|
||
- [01-project_memory.md](./memory/01-project_memory.md)：依赖小版本号、历史决策、变更时间轴
|
||
|
||
---
|
||
|
||
## coordination/ — 多窗口协作运行时目录
|
||
|
||
- 用途：并行 solo 窗口下的"谁在改什么"登记表与共享文件清单（**运行时数据，非冷文档**）
|
||
- 协作协议详见 [07-并行窗口冲突规约.md](./rules/全局/07-并行窗口冲突规约.md)
|
||
- 文件：
|
||
- [00-README.md](./coordination/00-README.md)：目录约定
|
||
- [01-ownership.md](./coordination/01-ownership.md)：文件/目录所有权（Writer）登记
|
||
- [02-shared-files.md](./coordination/02-shared-files.md)：本阶段共享文件清单（Integrator 维护）
|
||
- `handoff/`、`wip/`：差异建议交接 / 编译中途状态（按需新建）
|