- 完成 T-001A: 前端项目初始化 (Next.js 14 + TypeScript + Tailwind CSS) - 完成 T-001B: 后端项目初始化 (FastAPI + SQLAlchemy + asyncpg) - 完成 T-002: 数据库配置 (KolVideo 模型 + 索引 + 测试) - 完成 T-003: 基础 UI 框架 (Header/Footer 组件 + 品牌色系) - 完成 T-004: 环境变量配置 (前后端环境变量) Co-Authored-By: Claude <noreply@anthropic.com>
178 lines
4.7 KiB
Markdown
178 lines
4.7 KiB
Markdown
---
|
||
name: rp
|
||
description: 评审 PRD.md,对比 RequirementsDoc 检查一致性,输出结构化评审报告。
|
||
---
|
||
|
||
# Review PRD
|
||
|
||
当用户调用 `/rp` 时,执行以下步骤:
|
||
|
||
## 1. 读取文档
|
||
|
||
读取以下文件:
|
||
- 目标文档:`doc/PRD.md`
|
||
- 上游文档:`doc/RequirementsDoc.md`
|
||
|
||
如果 PRD.md 不存在,提示用户:
|
||
> PRD.md 不存在,请先使用 `/wp` 生成 PRD。
|
||
|
||
如果 RequirementsDoc.md 不存在,提示用户:
|
||
> RequirementsDoc.md 不存在,无法进行一致性检查。请先创建需求文档。
|
||
|
||
## 2. 评审维度
|
||
|
||
PRD 位于文档链的第二层,需要对比上游 RequirementsDoc 进行评审。
|
||
|
||
### 2.1 与 RequirementsDoc 的一致性
|
||
|
||
- [ ] PRD 是否覆盖了 RequirementsDoc 中的所有功能需求
|
||
- [ ] PRD 是否覆盖了 RequirementsDoc 中的所有非功能需求
|
||
- [ ] PRD 中是否有 RequirementsDoc 中未提及的需求(需标注来源)
|
||
- [ ] 术语定义是否与 RequirementsDoc 一致
|
||
- [ ] 优先级划分是否与 RequirementsDoc 一致
|
||
|
||
### 2.2 用户故事质量
|
||
|
||
- [ ] 所有用户故事是否有唯一 ID(US-xxx)
|
||
- [ ] 用户故事是否符合格式:作为{角色},我想要{功能},以便{价值}
|
||
- [ ] 用户角色是否明确定义
|
||
- [ ] 验收标准是否具体可测试
|
||
- [ ] 用户旅程是否完整描述核心流程
|
||
|
||
### 2.3 功能需求完整性
|
||
|
||
- [ ] 功能架构是否清晰(模块划分合理)
|
||
- [ ] 所有功能点是否关联到用户故事
|
||
- [ ] 功能点是否有明确的优先级
|
||
- [ ] 功能点是否有验收标准
|
||
- [ ] 是否遗漏边界情况和异常处理
|
||
|
||
### 2.4 非功能需求
|
||
|
||
- [ ] 性能需求是否有量化指标
|
||
- [ ] 安全需求是否明确
|
||
- [ ] 兼容性需求是否完整
|
||
- [ ] 可用性需求是否可验证
|
||
|
||
### 2.5 文档结构
|
||
|
||
- [ ] 文档结构是否完整(无空章节)
|
||
- [ ] 格式是否统一(表格、列表、标题层级)
|
||
- [ ] 术语表是否完整
|
||
|
||
## 3. 生成评审报告
|
||
|
||
按以下格式输出评审报告:
|
||
|
||
```markdown
|
||
# PRD 评审报告
|
||
|
||
## 概要
|
||
|
||
| 项目 | 内容 |
|
||
|------|------|
|
||
| 评审时间 | {YYYY-MM-DD HH:mm} |
|
||
| 目标文档 | doc/PRD.md |
|
||
| 参照文档 | doc/RequirementsDoc.md |
|
||
| 问题统计 | {critical} 个严重 / {major} 个一般 / {minor} 个建议 |
|
||
|
||
## 一致性检查
|
||
|
||
### 需求覆盖分析
|
||
|
||
| RequirementsDoc 需求项 | PRD 对应位置 | 状态 |
|
||
|------------------------|--------------|------|
|
||
| {需求1} | {PRD章节/用户故事ID} | ✅ 已覆盖 / ⚠️ 部分覆盖 / ❌ 未覆盖 |
|
||
|
||
### 差异说明
|
||
|
||
{列出 PRD 中新增的、RequirementsDoc 未提及的内容,需说明来源或理由}
|
||
|
||
## 问题清单
|
||
|
||
### 严重问题 (Critical)
|
||
|
||
> 必须修复,否则影响后续文档生成
|
||
|
||
1. **[位置: doc/PRD.md:行号]** 问题描述
|
||
- 现状:...
|
||
- 与 RequirementsDoc 的差异:...
|
||
- 建议:...
|
||
|
||
### 一般问题 (Major)
|
||
|
||
> 建议修复,可提升文档质量
|
||
|
||
1. **[位置]** 问题描述
|
||
- 建议:...
|
||
|
||
### 改进建议 (Minor)
|
||
|
||
> 可选优化项
|
||
|
||
1. **[位置]** 建议内容
|
||
|
||
## 用户故事评估
|
||
|
||
| 评估项 | 结果 |
|
||
|--------|------|
|
||
| 用户故事总数 | {数量} |
|
||
| 符合格式规范 | {数量} / {总数} |
|
||
| 有验收标准 | {数量} / {总数} |
|
||
| 关联功能点 | {数量} / {总数} |
|
||
|
||
### 用户故事问题
|
||
|
||
{列出不符合规范的用户故事}
|
||
|
||
## 评审结论
|
||
|
||
{通过 / 需修改后通过 / 不通过}
|
||
|
||
**结论说明**:
|
||
- 通过:PRD 与 RequirementsDoc 一致,可进入下一阶段
|
||
- 需修改后通过:存在问题但不影响整体理解,修复后可继续
|
||
- 不通过:存在严重一致性问题或遗漏,需重新生成
|
||
|
||
### 下一步行动
|
||
|
||
- [ ] 行动项1
|
||
- [ ] 行动项2
|
||
```
|
||
|
||
## 4. 保存报告
|
||
|
||
将评审报告保存到 `doc/review-PRD-claude.md`。
|
||
|
||
如果文件已存在,覆盖原文件(历史版本通过 git 追溯)。
|
||
|
||
## 5. 输出摘要
|
||
|
||
向用户展示评审摘要:
|
||
- 一致性检查结果(覆盖率)
|
||
- 发现的问题数量(按严重程度分类)
|
||
- 用户故事评估结果
|
||
- 评审结论
|
||
- 报告文件路径
|
||
|
||
---
|
||
|
||
## 注意事项
|
||
|
||
- 评审时保持客观,聚焦于文档质量和一致性
|
||
- 问题描述要具体,给出明确的位置引用(如 `doc/PRD.md:42`)
|
||
- 一致性检查要逐项对比,不能遗漏
|
||
- 建议要可操作,避免模糊表述
|
||
- 不要修改原文档,只输出评审报告
|
||
|
||
## 常见问题模式
|
||
|
||
在评审时重点关注以下常见问题:
|
||
|
||
1. **需求遗漏**:RequirementsDoc 中有但 PRD 中没有的需求
|
||
2. **需求偏离**:PRD 中的描述与 RequirementsDoc 不一致
|
||
3. **凭空添加**:PRD 中有但 RequirementsDoc 中没有的需求(需要来源说明)
|
||
4. **用户故事缺陷**:格式不规范、缺少验收标准、角色不明确
|
||
5. **功能孤立**:功能点未关联到任何用户故事
|
||
6. **优先级冲突**:PRD 与 RequirementsDoc 的优先级划分不一致
|