需求文档撰写规范

概述

本文档定义需求文档的撰写规范，确保需求文档结构清晰、逻辑性强、可执行。

文档结构

# {项目名称} 需求文档

## 一、项目概述

### 1.1 项目背景
- 项目背景描述
- 当前问题/痛点

### 1.2 核心目标
- 主要目标（2-3条）
- 预期效果

### 1.3 目标用户
- 用户画像
- 核心场景

---

## 二、功能需求

### 2.1 P0级功能（必须实现）

#### 功能名称
**问题**：描述当前痛点
**解决方案**：如何解决
**核心交互**：用户操作流程
**数据结构**：关键数据模型（如涉及）

### 2.2 P1级功能（重要）

### 2.3 P2级功能（可选）

---

## 三、数据结构设计

### 3.1 核心实体
- 实体定义
- 关系图（如涉及）

### 3.2 数据模型
```json
{
  "field": "类型",
  "description": "说明"
}

四、API规划

五、风险分析

六、执行计划

阶段划分

1. 阶段一：时间范围，目标
2. 阶段二：时间范围，目标

里程碑

• 里程碑1：日期，交付物

七、附录

术语表

| 术语 | 定义 |

参考资料

• 相关文档链接

---

## 撰写要点

### 1. 项目概述
- 背景要具体，说明"为什么做"
- 目标要量化，说明"做到什么程度"
- 用户要明确，说明"给谁用"

### 2. 功能需求
- **P0**：必须实现，影响核心价值
- **P1**：重要功能，影响用户体验
- **P2**：锦上添花，可后续迭代

每个功能需包含：
- 问题：当前痛点是什么
- 解决方案：如何解决
- 核心交互：用户怎么操作

### 3. 数据结构设计
- 核心实体用表格或JSON描述
- 字段命名遵循项目编码规范
- 关联关系需明确标注

### 4. API规划
- 接口设计遵循RESTful规范
- 标注方法（GET/POST/PUT/DELETE）
- 复杂接口需补充请求/响应示例

### 5. 风险分析
**五大维度**：
- 技术风险：技术难点、依赖风险
- 合规风险：法律、政策、隐私
- 商业风险：市场、竞争、变现
- 运营风险：用户接受度、推广难度
- 财务风险：成本、收益、投入产出

**标注要求**：
- 概率：高/中/低
- 影响程度：高/中/低
- 应对措施：具体可执行

### 6. 执行计划
- 阶段划分清晰
- 每阶段有明确交付物
- **时间估算按AI开发效率评估**（非人类团队标准）
- AI开发时间约为人类团队的20%-25%

---

## 文档规范

### 文档要求
- 结构清晰，逻辑性强
- 无重复内容
- 重点突出

### 命名规范
- 文件名：`{项目名称}需求文档.md`
- 示例：`小说创作工具2.0需求文档.md`

### 存储位置
- **主存储**：`/root/projects/知识库/project/`
- **飞书文档**：用于展示和汇报

---

## 模板调用

当用户要求撰写需求文档时，按以下步骤执行：

1. **获取上下文**
   - 从知识库 `project/` 目录获取项目背景
   - 从知识库 `standard/` 目录获取开发规范
   - 从知识库 `preference/` 目录获取用户偏好

2. **撰写文档**
   - 按本文档结构撰写
   - 风险分析必须包含五大维度
   - 每个风险标注概率和影响程度

3. **存储文档**
   - 保存到服务器知识库 `project/` 目录
   - 同步到飞书文档用于展示

4. **通知用户**
   - 发送文档给用户审阅
   - 等待反馈后迭代优化