26 lines
970 B
Markdown
26 lines
970 B
Markdown
|
# docs 目录说明
|
||
|
|
|
||
|
|
本目录按文档类型整理，优先解决历史文档集中堆放在 `docs/plans/` 根目录的问题。
|
||
|
|
|
||
|
|
## 目录结构
|
||
|
|
|
||
|
|
- `design/`: 设计文档与设计附属文件
|
||
|
|
- `plans/backend/`: 后端实施计划
|
||
|
|
- `plans/frontend/`: 前端实施计划
|
||
|
|
- `plans/fullstack/`: 综合实施计划、集成计划与通用实施记录
|
||
|
|
- `plans/misc/`: 计划类杂项文档
|
||
|
|
- `tests/plans/`: 测试计划
|
||
|
|
- `tests/records/`: 测试记录
|
||
|
|
- `tests/scripts/`: 测试脚本与脚本说明
|
||
|
|
- `reports/implementation/`: 实施报告
|
||
|
|
- `reports/optimization/`: 优化记录
|
||
|
|
- `reports/code-review/`: 代码评审报告
|
||
|
|
|
||
|
|
## 归类规则
|
||
|
|
|
||
|
|
- 设计类文档统一放入 `design/`
|
||
|
|
- 明确标注前端或后端的实施计划分别放入 `plans/frontend/`、`plans/backend/`
|
||
|
|
- 不区分前后端的综合方案、集成计划和通用实施文档放入 `plans/fullstack/`
|
||
|
|
- 测试相关文档统一放入 `tests/`
|
||
|
|
- 报告与复盘类文档统一放入 `reports/`
|