23 lines
1.1 KiB
Markdown
23 lines
1.1 KiB
Markdown
# docs — 开发文档
|
||
|
||
本目录存放项目的全部开发文档，涵盖需求、设计、功能规格、实施跟踪和质量验证。
|
||
|
||
## 目录说明
|
||
|
||
| 子目录 | 用途 | 受众 | 必选 |
|
||
|--------|------|------|:--:|
|
||
| `requirements/` | 需求与变更管理 | 产品、开发、测试 | 可选 |
|
||
| `design/` | 架构设计与技术方案 | 开发、架构师 | ✅ |
|
||
| `features/` | 功能规格说明 | 开发、测试、产品 | ✅ |
|
||
| `implementation/` | 实施计划与任务跟踪 | 开发、项目管理 | 可选 |
|
||
| `verify/` | 人工检查清单（上线/代码审查/安全审计） | 开发、运维 | 可选 |
|
||
|
||
> - 标记"可选"的目录：如果团队已使用 Jira/TAPD/飞书等工单系统管理需求和任务，可直接删除，避免双写不同步。
|
||
> - `verify/` 与 `test/` 的区别：`test/` 是**自动化代码测试**，`verify/` 是**人工检查清单和验证流程**。
|
||
|
||
## 使用原则
|
||
|
||
1. 文档**与代码同步更新**，不是一次性交付物
|
||
2. 优先用 Markdown，便于版本控制和 AI 工具阅读
|
||
3. 每个文档文件保持聚焦，一个文件讲清一件事
|