# 文档分类

## 组织原则

文档按“需求/项目专题”聚合，按 `type` 元数据分类。

目录不是唯一分类依据。稳定关联依赖以下字段：

- `feature_id`：需求、项目、专题主线
- `doc_id`：单篇文档唯一编号
- `type`：文档类型
- `status`：文档生命周期状态
- `related_docs`：关联文档
- `related_modules`：关联代码模块

## 一级目录

| 目录 | 用途 |
|---|---|
| `docs/initiatives/` | 需求、项目、专题主线文档 |
| `docs/adr/` | 架构决策记录 |
| `docs/api/` | 对外接口契约、OpenAPI、联调说明 |
| `docs/architecture/` | 长期有效的系统架构和模块边界 |
| `docs/standards/` | 工程规约、编码规范、架构红线 |
| `docs/operations/` | 部署、运维、故障处理、Runbook |
| `docs/templates/` | 文档模板 |
| `docs/assets/` | 全局图片和附件 |
| `docs/governance/` | 文档治理规则 |

历史中文粗分类目录已迁移到 `docs/initiatives/`、`docs/standards/` 和 `docs/api/`。

## 文档类型

| type | 编号前缀 | 用途 |
|---|---:|---|
| `intake` | `INT` | 需求录入、初步判断、来源记录 |
| `prd` | `PRD` | 需求文档、业务目标、范围、验收口径 |
| `outline-design` | `ODS` | 概要设计、总体方案、模块边界 |
| `detailed-design` | `DDS` | 详细设计、数据模型、异常、安全和实现细节 |
| `design` | `DES` | 技术设计、模块设计、数据模型、时序和边界 |
| `api` | `API` | 接口说明、联调说明、OpenAPI 关联 |
| `adr` | `ADR` | 架构决策记录 |
| `dev-progress` | `DEV` | 开发进度、范围变化、阻塞项和阶段记录 |
| `standard` | `STD` | 工程规约、编码规范、架构约束 |
| `meeting` | `MTG` | 会议纪要、评审记录 |
| `test-plan` | `TST` | 测试计划、验收方案、回归清单 |
| `test-result` | `TRS` | 测试结果、失败项、遗留问题和结论 |
| `runbook` | `RUN` | 部署、运维、故障处理步骤 |
| `research` | `RSH` | 调研、竞品、技术预研 |
| `prompt` | `PMT` | AI Prompt、智能体配置、Dify/FastGPT 提示词 |

## 编号规则

`feature_id`：

```text
FEAT-YYYYMM-NNN-short-name
```

`doc_id`：

```text
<TYPE>-YYYYMM-NNN
```

示例：

```text
FEAT-202606-001-unified-entry-client
PRD-202606-001
DES-202606-001
API-202606-001
MTG-202606-001
```

同一 `feature_id` 下可以有多篇不同 `type` 的文档。`doc_id` 必须全仓库唯一。