Expand user requirements into detailed DevDocs documents. Use when users provide feature requirements, want to clarify requirements, or need to create product requirement documents...
将用户简短需求扩展为结构化的需求文档,建立功能点、用户故事、验收标准的关联体系。
/devdocs-feature 的增量需求委托/devdocs-requirements → 自动检测模式
/devdocs-requirements --incremental → 强制增量模式
| 模式 | 触发条件 | 说明 |
|---|---|---|
| 初始模式 | 无 01-requirements.md |
从零创建需求文档 |
| 增量模式 | 已有 01-requirements.md |
扫描编号 + 追加需求 |
1. 理解需求
│
▼
2. 探索代码库(如适用)
│
▼
3. 识别功能点 (F-XXX)
│
▼
4. 编写用户故事 (US-XXX)
│
▼
5. 定义验收标准 (AC-XXX)
│
▼
6. 生成追溯矩阵
│
▼
7. 用户确认
1. 扫描现有编号
│
├── 读取 01-requirements.md
└── 获取 F/US/AC 最大编号
│
▼
2. 理解新增需求
│
▼
3. 追加功能点/用户故事/验收标准
│
├── 延续现有编号
└── 标注增量版本和日期
│
▼
4. 更新追溯矩阵
│
▼
5. 用户确认
│
▼
6. 返回新增编号列表(供调用方使用)
| 类型 | 前缀 | 格式 | 示例 |
|---|---|---|---|
| 功能点 | F | F-XXX | F-001, F-002 |
| 用户故事 | US | US-XXX | US-001, US-002 |
| 验收标准 | AC | AC-XXX | AC-001, AC-002 |
编号规则:
主文件:docs/devdocs/01-requirements.md
如文档超过 300 行,可拆分为:
01-requirements.md - 概览和功能点01-requirements-stories.md - 用户故事详情01-requirements-nfr.md - 非功能性需求详细模板参见 templates/requirements-template.md
# 需求文档:<功能名称>
## 1. 背景与目标
## 2. 功能点清单
## 3. 用户故事
## 4. 验收标准
## 5. 追溯矩阵
## 6. 非功能性需求
## 7. 范围边界
## 8. 风险与假设
功能点是用户可感知的独立功能单元。
识别方法:
示例:
| 编号 | 功能点 | 描述 | 优先级 |
|------|--------|------|--------|
| F-001 | 用户注册 | 新用户通过邮箱注册账号 | P0 |
| F-002 | 用户登录 | 已注册用户登录系统 | P0 |
| F-003 | 密码找回 | 用户通过邮箱重置密码 | P1 |
用户故事描述用户如何使用功能点完成目标。
格式:作为 <角色>,我希望 <功能>,以便 <价值>
示例:
| 编号 | 功能点 | 角色 | 期望 | 目的 |
|------|--------|------|------|------|
| US-001 | F-001 | 新用户 | 使用邮箱注册 | 获得系统访问权限 |
| US-002 | F-001 | 新用户 | 设置安全密码 | 保护账号安全 |
| US-003 | F-002 | 已注册用户 | 使用邮箱密码登录 | 进入系统 |
验收标准定义用户故事的完成条件,是测试用例设计的依据。
原则:
示例:
### US-001: 使用邮箱注册
| 编号 | 标准描述 | 验证方式 |
|------|----------|----------|
| AC-001 | 有效邮箱格式可以提交注册 | 输入 test@example.com,提交成功 |
| AC-002 | 已存在邮箱显示错误提示 | 输入已注册邮箱,显示"邮箱已存在" |
| AC-003 | 注册成功后发送验证邮件 | 收到包含验证链接的邮件 |
追溯矩阵展示功能点、用户故事、验收标准的关联关系。
示例:
| 功能点 | 用户故事 | 验收标准 |
|--------|----------|----------|
| F-001 | US-001 | AC-001, AC-002, AC-003 |
| F-001 | US-002 | AC-004, AC-005 |
| F-002 | US-003 | AC-006, AC-007, AC-008 |
从现有文档提取最大编号:
## 当前状态
| 类型 | 当前最大编号 | 下一编号 |
|------|-------------|----------|
| 功能点 (F) | F-003 | F-004 |
| 用户故事 (US) | US-008 | US-009 |
| 验收标准 (AC) | AC-015 | AC-016 |
---
## 功能迭代 v2: <功能名称> (2024-01-15)
> 本次新增 F-004,包含 2 个用户故事、5 个验收标准。
### F-004: <功能名称>
**描述**:<功能描述>
**用户故事**:
| 编号 | 角色 | 期望 | 目的 |
|------|------|------|------|
| US-009 | 作为<角色> | 我希望<功能> | 以便于<价值> |
**验收标准**:
- [ ] AC-016: <标准1>
- [ ] AC-017: <标准2>
增量模式完成后,返回新增编号列表供调用方使用:
新增编号:
- F-004
- US-009, US-010
- AC-016 ~ AC-020
| 场景 | 协作 Skill | 说明 |
|---|---|---|
| 新功能需求 | /devdocs-feature |
被调用:新功能触发需求追加 |
| 洞察转化 | /devdocs-insights |
被调用:改进建议转化为需求 |
| Bug 暴露需求 | /devdocs-bugfix |
被调用:Bug 修复发现需求缺失 |
| 项目改造 | /devdocs-retrofit |
被调用:逆向推导生成需求 |
| 设计阶段 | /devdocs-system-design |
后续:需求确认后进入设计 |
完成后建议运行 /devdocs-system-design 进行系统设计。