feat: 根目录文档、脚本、gitignore
This commit is contained in:
@@ -0,0 +1,84 @@
|
||||
# 验收标准模板(pmassist-v3)
|
||||
|
||||
> **使用说明**:
|
||||
> - 文件路径:`outputs/acceptance.md`
|
||||
> - AC 编号格式:`AC-{FR编号后缀}-{序号}`,例如:AC-001-1(FR-001 的第1条AC)
|
||||
> - 每条 FR 至少包含:1条正常路径 + 1条异常路径
|
||||
> - 权限代码格式参考系统约定(如:`serviceCardOrder:create`)
|
||||
|
||||
---
|
||||
|
||||
## AC 覆盖概要
|
||||
|
||||
| FR 编号 | FR 标题 | AC 条数 | 覆盖状态 |
|
||||
|---|---|---|---|
|
||||
| FR-001 | | 2 | ✅ |
|
||||
| FR-002 | | 0 | ⚠️ 待补充 |
|
||||
|
||||
---
|
||||
|
||||
## AC-001 {功能名称} — {场景描述}
|
||||
|
||||
**追溯**:FR-001
|
||||
**权限**:`{权限代码}`(如有)
|
||||
|
||||
### AC-001-1(正常路径)
|
||||
|
||||
- **Given**:{用户角色/前置条件/数据状态}
|
||||
- **When**:{触发动作,如:点击「提交」}
|
||||
- **Then**:
|
||||
- {期望结果1,描述系统行为}
|
||||
- {期望结果2,描述数据变化}
|
||||
- {期望结果3,描述页面反馈}
|
||||
|
||||
### AC-001-2(异常路径 - 参数校验)
|
||||
|
||||
- **Given**:{异常前置条件,如:必填项未填写}
|
||||
- **When**:{触发动作}
|
||||
- **Then**:
|
||||
- 系统应返回错误提示:"{错误提示文案}"
|
||||
- 操作不应被执行
|
||||
- 数据不应产生变更
|
||||
|
||||
### AC-001-3(边界条件 - 状态校验)
|
||||
|
||||
- **Given**:{边界条件,如:记录已处于终态}
|
||||
- **When**:{触发动作}
|
||||
- **Then**:
|
||||
- {系统拒绝操作,并给出说明}
|
||||
|
||||
---
|
||||
|
||||
## AC-002 {功能名称} — {场景描述}
|
||||
|
||||
**追溯**:FR-002
|
||||
**权限**:`{权限代码}`(如有)
|
||||
|
||||
### AC-002-1(正常路径)
|
||||
|
||||
- **Given**:
|
||||
- **When**:
|
||||
- **Then**:
|
||||
-
|
||||
|
||||
### AC-002-2(异常路径)
|
||||
|
||||
- **Given**:
|
||||
- **When**:
|
||||
- **Then**:
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
<!-- 继续添加 AC-003, AC-004... -->
|
||||
|
||||
---
|
||||
|
||||
## 附:验收标准覆盖矩阵
|
||||
|
||||
| AC 编号 | 对应 FR | 路径类型 | 优先级 | 状态 |
|
||||
|---|---|---|---|---|
|
||||
| AC-001-1 | FR-001 | 正常路径 | P0 | 待验收 |
|
||||
| AC-001-2 | FR-001 | 异常路径 | P0 | 待验收 |
|
||||
| AC-001-3 | FR-001 | 边界条件 | P1 | 待验收 |
|
||||
| AC-002-1 | FR-002 | 正常路径 | P1 | 待验收 |
|
||||
@@ -0,0 +1,257 @@
|
||||
# DAR 模板(缺陷分析报告)— pmassist-v3
|
||||
|
||||
> **使用说明**:按 8D/根因分析思路组织,所有结论需引用证据。
|
||||
> 涉及代码问题时优先查阅 CodeMap/DomainMap,支持精准根因定位。
|
||||
|
||||
---
|
||||
|
||||
## 0. 文档信息
|
||||
|
||||
| 字段 | 内容 |
|
||||
|---|---|
|
||||
| 缺陷编号 | BUG-xxx |
|
||||
| 版本 | v1.0 |
|
||||
| 状态 | 分析中 / 已修复 / 已验证 |
|
||||
| 作者 | |
|
||||
| 创建日期 | |
|
||||
| 最后更新 | |
|
||||
|
||||
---
|
||||
|
||||
## 1. 缺陷概述
|
||||
|
||||
### 1.1 问题描述
|
||||
> 简要描述缺陷现象,用一句话概括。
|
||||
|
||||
### 1.2 影响范围
|
||||
|
||||
| 维度 | 说明 |
|
||||
|---|---|
|
||||
| 影响用户数 | |
|
||||
| 影响业务功能 | |
|
||||
| 影响系统/服务 | |
|
||||
| 影响时间窗口 | |
|
||||
|
||||
### 1.3 严重级别与优先级
|
||||
|
||||
| 项目 | 值 |
|
||||
|---|---|
|
||||
| 严重级别 | P0(紧急)/ P1(严重)/ P2(一般)/ P3(轻微)|
|
||||
| 处理优先级 | 立即修复 / 本迭代修复 / 下迭代修复 |
|
||||
|
||||
---
|
||||
|
||||
## 2. 复现信息
|
||||
|
||||
### 2.1 复现步骤
|
||||
|
||||
1. 步骤一
|
||||
2. 步骤二
|
||||
3. 步骤三
|
||||
|
||||
### 2.2 期望结果 vs 实际结果
|
||||
|
||||
| | 描述 |
|
||||
|---|---|
|
||||
| **期望结果** | |
|
||||
| **实际结果** | |
|
||||
|
||||
### 2.3 环境信息
|
||||
|
||||
| 项目 | 值 |
|
||||
|---|---|
|
||||
| 系统版本 | |
|
||||
| 分支/Tag | |
|
||||
| 设备/网络 | |
|
||||
| 账号/角色 | |
|
||||
|
||||
### 2.4 相关证据
|
||||
|
||||
| 类型 | 路径/描述 |
|
||||
|---|---|
|
||||
| 日志 | [SRC-001] |
|
||||
| 截图 | [SRC-002] |
|
||||
| 接口请求 | [SRC-003] |
|
||||
| 监控数据 | |
|
||||
|
||||
---
|
||||
|
||||
## 3. 时间线
|
||||
|
||||
| 时间 | 事件 | 操作人 |
|
||||
|---|---|---|
|
||||
| | 首次发现 | |
|
||||
| | 问题升级 | |
|
||||
| | 临时止损 | |
|
||||
| | 根因确认 | |
|
||||
| | 修复上线 | |
|
||||
| | 验证通过 | |
|
||||
|
||||
---
|
||||
|
||||
## 4. 临时遏制措施(Containment)
|
||||
|
||||
### 4.1 当前止损方案
|
||||
|
||||
### 4.2 影响控制范围
|
||||
|
||||
---
|
||||
|
||||
## 5. 根因分析
|
||||
|
||||
### 5.1 直接原因
|
||||
|
||||
### 5.2 根本原因(5 Whys)
|
||||
|
||||
| 层次 | Why | 分析 | 证据 |
|
||||
|---|---|---|---|
|
||||
| 第1层 | 为什么出现缺陷? | | [SRC-001] |
|
||||
| 第2层 | 为什么第1层原因存在? | | |
|
||||
| 第3层 | 为什么第2层原因存在? | | |
|
||||
| 第4层 | 为什么第3层原因存在? | | |
|
||||
| 第5层 | 根本原因 | | |
|
||||
|
||||
### 5.3 根因类型分类
|
||||
|
||||
- [ ] 代码逻辑错误
|
||||
- [ ] 边界条件未处理
|
||||
- [ ] 需求理解偏差
|
||||
- [ ] 测试覆盖不足
|
||||
- [ ] 配置/环境问题
|
||||
- [ ] 第三方依赖问题
|
||||
- [ ] 数据质量问题
|
||||
- [ ] 其他:______
|
||||
|
||||
### 5.4 触发条件与边界
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[触发条件] --> B{边界判断}
|
||||
B -->|条件A| C[正常路径]
|
||||
B -->|条件B| D[Bug触发路径]
|
||||
D --> E[问题结果]
|
||||
```
|
||||
|
||||
### 5.5 代码根因定位
|
||||
|
||||
> 引用 CodeMap/DomainMap 精准定位。
|
||||
|
||||
| 文件/类 | 方法 | 行号(约) | 问题说明 | 证据 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | [CODEMAP:...] |
|
||||
|
||||
---
|
||||
|
||||
## 6. 纠正措施(Corrective Action)
|
||||
|
||||
### 6.1 修复方案
|
||||
|
||||
| 方案 | 描述 | 影响范围 | 风险 | 结论 |
|
||||
|---|---|---|---|---|
|
||||
| 方案 A(选定)| | | | ✅ 采用 |
|
||||
| 方案 B | | | | ❌ 放弃 |
|
||||
|
||||
### 6.2 修复影响评估
|
||||
|
||||
| 维度 | 影响说明 |
|
||||
|---|---|
|
||||
| 影响模块 | |
|
||||
| 数据迁移 | 需要 / 不需要 |
|
||||
| 接口变更 | 有 / 无 |
|
||||
| 回归范围 | |
|
||||
|
||||
### 6.3 回归验证要点
|
||||
|
||||
| 验证项 | 说明 | 负责人 |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
---
|
||||
|
||||
## 7. 效果验证
|
||||
|
||||
### 7.1 验证方式与结果
|
||||
|
||||
| 验证项 | 方式 | 结果 | 时间 |
|
||||
|---|---|---|---|
|
||||
| | 自动化测试/手工测试 | ✅/❌ | |
|
||||
|
||||
### 7.2 监控/指标变化
|
||||
|
||||
| 指标 | 修复前 | 修复后 | 变化 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
---
|
||||
|
||||
## 8. 预防措施与改进
|
||||
|
||||
### 8.1 预防机制
|
||||
|
||||
| 类型 | 措施 | 负责人 | 完成时间 |
|
||||
|---|---|---|---|
|
||||
| 监控告警 | | | |
|
||||
| 测试补充 | | | |
|
||||
| 流程改进 | | | |
|
||||
| 代码规范 | | | |
|
||||
|
||||
### 8.2 长期改进计划
|
||||
|
||||
| 改进项 | 优先级 | 计划时间 | 负责方 |
|
||||
|---|---|---|---|
|
||||
| | P1 | | |
|
||||
|
||||
---
|
||||
|
||||
## 9. 经验总结
|
||||
|
||||
### 9.1 经验教训
|
||||
|
||||
| 类别 | 教训 | 对应改进措施 |
|
||||
|---|---|---|
|
||||
| 研发 | | |
|
||||
| 测试 | | |
|
||||
| 运维 | | |
|
||||
| 产品 | | |
|
||||
|
||||
### 9.2 可复用的规则/检查项
|
||||
|
||||
> 归纳为可在未来需求中复用的防范规则。
|
||||
|
||||
- [ ] {检查项1}
|
||||
- [ ] {检查项2}
|
||||
|
||||
---
|
||||
|
||||
## 10. 证据与引用
|
||||
|
||||
- 引用 `materials_index.md` 中的 SRC-xxx
|
||||
- CODEMAP/DOMAINMAP/RUNTIME 证据引用
|
||||
|
||||
---
|
||||
|
||||
## 11. 证据映射表(强制)
|
||||
|
||||
| 章节 | 关键结论 | 证据 | 状态 |
|
||||
|---|---|---|---|
|
||||
| 复现信息 | | | |
|
||||
| 根因分析 | | | |
|
||||
| 纠正措施 | | | |
|
||||
| 效果验证 | | | |
|
||||
|
||||
---
|
||||
|
||||
## 12. 系统资产引用(强制)
|
||||
|
||||
| 资产类型 | 路径 | 用途 |
|
||||
|---|---|---|
|
||||
| CodeMap | | |
|
||||
| DomainMap | | |
|
||||
| Runtime | | |
|
||||
|
||||
---
|
||||
|
||||
## 图表要求(强制检查)
|
||||
|
||||
- [ ] 至少 1 个 mermaid 图(根因路径/修复流程/时间线任选)
|
||||
- [ ] 至少 1 张表(影响范围/根因层次/预防措施等)
|
||||
@@ -0,0 +1,298 @@
|
||||
# FRD 模板(pmassist-v3)
|
||||
|
||||
> **使用说明**:聚焦"可实现的功能规格"。需求条目使用 FR-xxx 编号,采用 WHEN/IF ... SHALL ... 语句。
|
||||
> 每条 FR 需对应 `outputs/acceptance.md` 中的 AC-xxx 验收标准。
|
||||
|
||||
---
|
||||
|
||||
## 0. 文档信息
|
||||
|
||||
| 字段 | 内容 |
|
||||
|---|---|
|
||||
| 版本 | v1.0 |
|
||||
| 状态 | 草稿 / 评审中 / 定稿 |
|
||||
| 作者 | |
|
||||
| 创建日期 | |
|
||||
| 最后更新 | |
|
||||
| 适用范围 | |
|
||||
|
||||
### 变更记录
|
||||
|
||||
| 版本 | 日期 | 变更编号 | 变更说明 | 影响 FR |
|
||||
|---|---|---|---|---|
|
||||
| v1.0 | | CHG-000 | 初稿 | 全部 |
|
||||
|
||||
---
|
||||
|
||||
## 1. 引言
|
||||
|
||||
### 1.1 目的
|
||||
|
||||
### 1.2 范围
|
||||
|
||||
### 1.3 术语与缩写
|
||||
|
||||
| 术语 | 说明 |
|
||||
|---|---|
|
||||
| | |
|
||||
|
||||
### 1.4 参考资料
|
||||
> 引用 `materials_index.md` 中的 SRC-xxx
|
||||
|
||||
---
|
||||
|
||||
## 2. 总体描述
|
||||
|
||||
### 2.1 产品视角(系统边界)
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
subgraph 本系统
|
||||
A[模块A] --> B[模块B]
|
||||
end
|
||||
C[上游系统] --> A
|
||||
B --> D[下游系统]
|
||||
```
|
||||
|
||||
### 2.2 功能概览
|
||||
|
||||
| 模块 | 功能 | 优先级 | 依赖 |
|
||||
|---|---|---|---|
|
||||
| | | P0/P1/P2 | |
|
||||
|
||||
### 2.3 用户特征
|
||||
|
||||
| 用户角色 | 权限级别 | 典型操作 |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
### 2.4 约束条件
|
||||
|
||||
### 2.5 假设与依赖
|
||||
|
||||
---
|
||||
|
||||
## 3. 功能需求(核心)
|
||||
|
||||
> **编号规则**:主功能 FR-001;子场景 FR-001-1。每条 FR 须有对应 AC。
|
||||
|
||||
### 3.1 功能需求列表
|
||||
|
||||
| FR 编号 | 标题 | 优先级 | 状态 | AC 引用 |
|
||||
|---|---|---|---|---|
|
||||
| FR-001 | | P0 | 待确认 | AC-001-1, AC-001-2 |
|
||||
| FR-002 | | P1 | 待确认 | |
|
||||
|
||||
### 3.2 功能需求详细说明
|
||||
|
||||
---
|
||||
|
||||
#### FR-001:{功能名称}
|
||||
|
||||
- **优先级**:P0 / P1 / P2
|
||||
- **角色/主体**:
|
||||
- **触发条件**:WHEN/IF {条件}
|
||||
- **需求**:系统 SHALL {做什么}
|
||||
- **业务规则**:
|
||||
1. {规则1}
|
||||
2. {规则2}
|
||||
- **边界条件/异常**:
|
||||
- WHEN {异常条件} → 系统 SHALL {处理方式}
|
||||
- **优先级**:P0
|
||||
- **依据/来源**:[SRC-001] / [CODEMAP:...] / [ASSUMPTION]
|
||||
- **验收标准**:AC-001-1, AC-001-2
|
||||
|
||||
---
|
||||
|
||||
#### FR-002:{功能名称}
|
||||
|
||||
(同上格式)
|
||||
|
||||
---
|
||||
|
||||
## 4. 外部接口需求
|
||||
|
||||
### 4.1 用户界面
|
||||
|
||||
| 页面/组件 | 输入字段 | 输出/展示 | 规则 | FR 引用 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
### 4.2 软件接口
|
||||
|
||||
| 接口名称 | 请求方法 | 说明 | FR 引用 | 证据 |
|
||||
|---|---|---|---|---|
|
||||
| POST /api/xxx | POST | | FR-001 | |
|
||||
|
||||
#### 接口详细说明
|
||||
|
||||
**接口:POST /api/{path}**
|
||||
|
||||
- **描述**:
|
||||
- **请求参数**:
|
||||
|
||||
```json
|
||||
{
|
||||
"field1": "string, 说明",
|
||||
"field2": 0,
|
||||
"field3": true
|
||||
}
|
||||
```
|
||||
|
||||
- **响应**:
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"msg": "success",
|
||||
"data": {}
|
||||
}
|
||||
```
|
||||
|
||||
- **错误码**:
|
||||
|
||||
| 错误码 | 说明 |
|
||||
|---|---|
|
||||
| 400 | 参数校验失败 |
|
||||
| 403 | 无权限 |
|
||||
|
||||
### 4.3 通信接口/协议
|
||||
|
||||
---
|
||||
|
||||
## 5. 数据需求
|
||||
|
||||
### 5.1 数据实体/字段定义
|
||||
|
||||
| 字段名 | 类型 | 必填 | 默认值 | 说明 | FR 引用 |
|
||||
|---|---|---|---|---|---|
|
||||
| | | | | | |
|
||||
|
||||
### 5.2 数据库 DDL
|
||||
|
||||
```sql
|
||||
-- 新建表
|
||||
CREATE TABLE `{表名}` (
|
||||
`id` BIGINT NOT NULL AUTO_INCREMENT COMMENT '主键',
|
||||
`code` VARCHAR(64) NOT NULL COMMENT '编号,格式:前缀+yyyyMMdd+6位顺序号',
|
||||
-- 业务字段...
|
||||
`status` TINYINT NOT NULL DEFAULT 0 COMMENT '状态:0=xxx,1=xxx,2=xxx',
|
||||
`create_by` VARCHAR(64) COMMENT '创建人',
|
||||
`create_time` DATETIME COMMENT '创建时间',
|
||||
`update_by` VARCHAR(64) COMMENT '更新人',
|
||||
`update_time` DATETIME COMMENT '更新时间',
|
||||
`del_flag` CHAR(1) NOT NULL DEFAULT '0' COMMENT '删除标志(0=存在,1=删除)',
|
||||
PRIMARY KEY (`id`),
|
||||
UNIQUE KEY `uk_code` (`code`),
|
||||
KEY `idx_status` (`status`),
|
||||
KEY `idx_create_time` (`create_time`)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='{表注释}';
|
||||
|
||||
-- 字段变更
|
||||
ALTER TABLE `{表名}`
|
||||
ADD COLUMN `{字段}` {类型} DEFAULT {值} COMMENT '{说明}' AFTER `{前一字段}`;
|
||||
```
|
||||
|
||||
### 5.3 数据校验规则
|
||||
|
||||
| 字段 | 校验规则 | 错误提示 | FR 引用 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
### 5.4 存储与迁移要求
|
||||
|
||||
---
|
||||
|
||||
## 6. 非功能需求
|
||||
|
||||
### 6.1 性能
|
||||
|
||||
| 指标 | 要求 | 说明 |
|
||||
|---|---|---|
|
||||
| 响应时间 | < 200ms (P95) | |
|
||||
| 并发 | | |
|
||||
| 吞吐 | | |
|
||||
|
||||
### 6.2 安全与权限
|
||||
|
||||
| 功能/接口 | 权限代码 | 角色 | 说明 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
### 6.3 可靠性/可用性
|
||||
|
||||
### 6.4 可维护性/可扩展性
|
||||
|
||||
---
|
||||
|
||||
## 7. 追踪与验收
|
||||
|
||||
### 7.1 需求追踪矩阵
|
||||
|
||||
| FR 编号 | 设计文档 | 实现位置 | 测试用例/AC | 状态 |
|
||||
|---|---|---|---|---|
|
||||
| FR-001 | | | AC-001-1~3 | |
|
||||
|
||||
### 7.2 验收用例清单
|
||||
> 详细 AC 见 `outputs/acceptance.md`
|
||||
|
||||
---
|
||||
|
||||
## 8. 风险与开放问题
|
||||
|
||||
| 风险/问题 | 类型 | 等级 | 应对措施 | 状态 |
|
||||
|---|---|---|---|---|
|
||||
| | 风险/待决问题 | 高/中/低 | | 开放/已关闭 |
|
||||
|
||||
---
|
||||
|
||||
## 9. 差异点清单
|
||||
|
||||
| 维度 | 现状 | 目标 | 影响 FR | 证据 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
---
|
||||
|
||||
## 10. 证据映射表(强制)
|
||||
|
||||
| 章节 | 关键结论 | 证据 | 状态 |
|
||||
|---|---|---|---|
|
||||
| 功能需求 | | | |
|
||||
| 接口需求 | | | |
|
||||
| 数据需求 | | | |
|
||||
| 非功能需求 | | | |
|
||||
|
||||
---
|
||||
|
||||
## 11. FR → AC 覆盖矩阵(强制)
|
||||
|
||||
| FR 编号 | FR 标题 | AC 数量 | AC 列表 | 覆盖状态 |
|
||||
|---|---|---|---|---|
|
||||
| FR-001 | | | AC-001-1, AC-001-2 | ✅ 已覆盖 |
|
||||
| FR-002 | | 0 | — | ⚠️ 待补充 |
|
||||
|
||||
---
|
||||
|
||||
## 12. 系统资产引用(强制)
|
||||
|
||||
| 资产类型 | 路径 | 用途 |
|
||||
|---|---|---|
|
||||
| CodeMap | | |
|
||||
| DomainMap | | |
|
||||
| Runtime | | |
|
||||
|
||||
---
|
||||
|
||||
## 13. 参考资料与索引
|
||||
|
||||
- 引用 `materials_index.md` 的来源 ID
|
||||
- CODEMAP/DOMAINMAP/RUNTIME 引用:见第 12 章
|
||||
|
||||
---
|
||||
|
||||
## 图表要求(强制检查)
|
||||
|
||||
- [ ] 至少 1 个 mermaid 图(系统边界/流程/时序任选)
|
||||
- [ ] 至少 1 张表(需求条目清单/接口列表/字段定义等)
|
||||
- [ ] FR→AC 覆盖矩阵已填写(第 11 章)
|
||||
@@ -0,0 +1,343 @@
|
||||
# PRD 模板(pmassist-v3)
|
||||
|
||||
> **使用说明**:按需裁剪,保留证据标注。所有关键结论需引用 `materials_index.md` 中的来源 ID。
|
||||
> FR 编号(FR-xxx)需与 `outputs/acceptance.md` 中的 AC 对应。
|
||||
|
||||
---
|
||||
|
||||
## 0. 文档信息
|
||||
|
||||
| 字段 | 内容 |
|
||||
|---|---|
|
||||
| 版本 | v1.0 |
|
||||
| 状态 | 草稿 / 评审中 / 定稿 |
|
||||
| 作者 | |
|
||||
| 创建日期 | |
|
||||
| 最后更新 | |
|
||||
| 适用范围 | |
|
||||
|
||||
### 变更记录
|
||||
|
||||
| 版本 | 日期 | 变更编号 | 变更说明 | 影响章节 |
|
||||
|---|---|---|---|---|
|
||||
| v1.0 | | CHG-000 | 初稿 | 全部 |
|
||||
|
||||
---
|
||||
|
||||
## 1. 业务背景
|
||||
|
||||
### 1.1 现状与痛点
|
||||
> 描述当前业务现状,用数据或事实证据支撑。
|
||||
|
||||
- 现状描述:[SRC-001]
|
||||
- 核心痛点:
|
||||
1. [ASSUMPTION]
|
||||
2. [ASSUMPTION]
|
||||
|
||||
### 1.2 业务目标与问题陈述
|
||||
> 本需求要解决的核心问题是什么?
|
||||
|
||||
### 1.3 相关历史决策
|
||||
> 可链接 `decision_log.md` 中的历史决策。
|
||||
|
||||
---
|
||||
|
||||
## 2. 目标与成功指标
|
||||
|
||||
### 2.1 业务目标(可量化)
|
||||
|
||||
| 目标 | 指标 | 当前值 | 目标值 | 截止时间 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
### 2.2 北极星指标
|
||||
|
||||
### 2.3 约束条件与边界
|
||||
- 时间约束:
|
||||
- 技术约束:
|
||||
- 合规约束:
|
||||
- 不在本期范围:
|
||||
|
||||
---
|
||||
|
||||
## 3. 用户与场景
|
||||
|
||||
### 3.1 目标用户/角色
|
||||
|
||||
| 角色 | 描述 | 典型诉求 |
|
||||
|---|---|---|
|
||||
| 运营 | | |
|
||||
| 用户/客户 | | |
|
||||
| 管理员 | | |
|
||||
|
||||
### 3.2 关键使用场景
|
||||
|
||||
| 场景编号 | 场景描述 | 涉及角色 | 优先级 |
|
||||
|---|---|---|---|
|
||||
| S-001 | | | P0 |
|
||||
| S-002 | | | P1 |
|
||||
|
||||
### 3.3 价值链路与利益相关方
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
A[角色1] --> B[操作] --> C[系统] --> D[结果]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. 需求范围
|
||||
|
||||
### 4.1 范围内(In Scope)
|
||||
|
||||
| 模块 | 功能 | 备注 |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
### 4.2 范围外(Out of Scope)
|
||||
|
||||
- 本期不做:
|
||||
1.
|
||||
2.
|
||||
|
||||
### 4.3 假设与依赖
|
||||
|
||||
| 依赖项 | 类型 | 状态 | 负责方 |
|
||||
|---|---|---|---|
|
||||
| | 内部/外部 | 待确认/已确认 | |
|
||||
|
||||
---
|
||||
|
||||
## 5. 整体方案介绍
|
||||
|
||||
### 5.1 方案概述
|
||||
|
||||
### 5.2 核心机制/策略
|
||||
|
||||
### 5.3 结算/计费/策略规则(如适用)
|
||||
|
||||
### 5.4 字段新增/调整
|
||||
|
||||
| 字段名 | 表/对象 | 类型 | 说明 | 证据 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
### 5.5 方案对比与取舍
|
||||
|
||||
| 方案 | 优点 | 缺点 | 结论 |
|
||||
|---|---|---|---|
|
||||
| 方案 A(选定)| | | ✅ 采用 |
|
||||
| 方案 B | | | ❌ 放弃 |
|
||||
|
||||
---
|
||||
|
||||
## 6. 需求内容
|
||||
|
||||
### 6.1 端/渠道覆盖矩阵(强制)
|
||||
|
||||
| 端/渠道 | 是否覆盖 | 核心差异点 | 涉及 FR | 证据 |
|
||||
|---|---|---|---|---|
|
||||
| 管理端 | ✅/❌/部分 | | FR-001~005 | |
|
||||
| 商户平台 | | | | |
|
||||
| 合伙人平台 | | | | |
|
||||
| 小程序/H5 | | | | |
|
||||
| API/开放接口 | | | | |
|
||||
| 其他端 | | | | |
|
||||
|
||||
### 6.2 功能需求列表(FR)
|
||||
|
||||
> **编号规则**:主功能 FR-001;子功能 FR-001-1。每条 FR 需有对应 AC(见 `outputs/acceptance.md`)。
|
||||
|
||||
#### FR-001:{功能名称}
|
||||
|
||||
- **优先级**:P0 / P1 / P2
|
||||
- **角色**:{涉及角色}
|
||||
- **触发条件**:WHEN/IF {条件}
|
||||
- **需求**:系统 SHALL {做什么}
|
||||
- **业务规则**:
|
||||
1. {规则1}
|
||||
2. {规则2}
|
||||
- **边界条件**:{非正常路径说明}
|
||||
- **证据**:[SRC-001] / [CODEMAP:...] / [ASSUMPTION]
|
||||
- **AC 引用**:AC-001-1, AC-001-2
|
||||
|
||||
#### FR-002:{功能名称}
|
||||
|
||||
(同上格式)
|
||||
|
||||
---
|
||||
|
||||
### 6.3 各端功能详细说明
|
||||
|
||||
> 按端展开,每端包含:业务流程 → 关键页面/交互 → 规则与校验 → 接口/数据
|
||||
|
||||
#### 6.3.1 管理端
|
||||
|
||||
**业务流程**:
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[开始] --> B{判断条件}
|
||||
B -->|是| C[执行操作]
|
||||
B -->|否| D[另一操作]
|
||||
C --> E[结束]
|
||||
D --> E
|
||||
```
|
||||
|
||||
**关键页面/交互**:
|
||||
|
||||
| 页面/组件 | 说明 | 关键字段/操作 |
|
||||
|---|---|---|
|
||||
| 列表页 | | |
|
||||
| 创建页 | | |
|
||||
| 详情页 | | |
|
||||
|
||||
**规则与校验**:
|
||||
1. {校验规则}
|
||||
|
||||
**接口/数据**:
|
||||
- 涉及接口:{接口名称}
|
||||
- 字段说明:参见第 7 章
|
||||
|
||||
---
|
||||
|
||||
## 7. 数据与埋点
|
||||
|
||||
### 7.1 数据模型(建议结构)
|
||||
|
||||
> 新建表或字段变更的建议结构,供技术方参考。
|
||||
|
||||
```sql
|
||||
-- 新建表示例
|
||||
CREATE TABLE `{表名}` (
|
||||
`id` BIGINT NOT NULL AUTO_INCREMENT COMMENT '主键',
|
||||
`code` VARCHAR(64) NOT NULL COMMENT '编号',
|
||||
-- 业务字段...
|
||||
`status` TINYINT NOT NULL DEFAULT 0 COMMENT '状态:0=xxx,1=xxx',
|
||||
`create_by` VARCHAR(64) COMMENT '创建人',
|
||||
`create_time` DATETIME COMMENT '创建时间',
|
||||
`update_by` VARCHAR(64) COMMENT '更新人',
|
||||
`update_time` DATETIME COMMENT '更新时间',
|
||||
`del_flag` CHAR(1) NOT NULL DEFAULT '0' COMMENT '删除标志',
|
||||
PRIMARY KEY (`id`)
|
||||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='';
|
||||
```
|
||||
|
||||
### 7.2 字段定义
|
||||
|
||||
| 字段名 | 类型 | 取值/范围 | 说明 | 来源 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
### 7.3 数据口径
|
||||
|
||||
| 指标名 | 计算方式 | 来源表/字段 | 备注 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
### 7.4 统计/埋点需求
|
||||
|
||||
| 事件名 | 触发时机 | 携带参数 | 用途 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
### 7.5 导出/对账口径
|
||||
|
||||
| 字段 | 页面展示 | 导出字段 | 对账字段 | 差异说明 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
---
|
||||
|
||||
## 8. 差异点清单(强制)
|
||||
|
||||
> 记录"现状 vs 目标"的差异,避免只写方案不写差异。
|
||||
|
||||
| 维度 | 现状 | 目标 | 影响范围 | 涉及 FR | 证据 |
|
||||
|---|---|---|---|---|---|
|
||||
| 策略差异 | | | | | |
|
||||
| 口径差异 | | | | | |
|
||||
| UI/交互差异 | | | | | |
|
||||
| 数据结构差异 | | | | | |
|
||||
| 权限差异 | | | | | |
|
||||
|
||||
---
|
||||
|
||||
## 9. 风险确认与应对
|
||||
|
||||
| 风险编号 | 风险描述 | 类型 | 等级 | 应对措施 | 负责人 |
|
||||
|---|---|---|---|---|---|
|
||||
| R-001 | | 合规/业务/技术/体验 | 高/中/低 | | |
|
||||
|
||||
### 9.1 回滚/灰度策略
|
||||
|
||||
---
|
||||
|
||||
## 10. 里程碑与发布计划
|
||||
|
||||
| 里程碑 | 交付物 | 时间 | 负责方 | 状态 |
|
||||
|---|---|---|---|---|
|
||||
| M0-需求确认 | PRD Final | | PM | |
|
||||
| M1-架构设计 | 架构文档 | | Arch | |
|
||||
| M2-开发完成 | 代码+单测 | | Dev | |
|
||||
| M3-测试通过 | 测试报告 | | QA | |
|
||||
| M4-上线 | 发布说明 | | DevOps | |
|
||||
|
||||
### 10.1 上线策略与验收标准
|
||||
|
||||
---
|
||||
|
||||
## 11. 其他需求 / 备注
|
||||
|
||||
### 11.1 重要决策记录
|
||||
> 可引用 `decision_log.md`
|
||||
|
||||
### 11.2 待后续决策事项
|
||||
|
||||
---
|
||||
|
||||
## 12. 证据映射表(强制)
|
||||
|
||||
| 章节 | 关键结论 | 证据 | 状态 |
|
||||
|---|---|---|---|
|
||||
| 业务背景 | | | |
|
||||
| 方案介绍 | | | |
|
||||
| 功能需求 | | | |
|
||||
| 数据与口径 | | | |
|
||||
| 风险 | | | |
|
||||
|
||||
---
|
||||
|
||||
## 13. FR → AC 覆盖矩阵(强制)
|
||||
|
||||
| FR 编号 | FR 标题 | AC 数量 | AC 列表 | 覆盖状态 |
|
||||
|---|---|---|---|---|
|
||||
| FR-001 | | 2 | AC-001-1, AC-001-2 | ✅ 已覆盖 |
|
||||
| FR-002 | | 0 | — | ⚠️ 待补充 |
|
||||
|
||||
---
|
||||
|
||||
## 14. 系统资产引用(强制)
|
||||
|
||||
| 资产类型 | 路径 | 用途 |
|
||||
|---|---|---|
|
||||
| CodeMap | | |
|
||||
| DomainMap | | |
|
||||
| Runtime | | |
|
||||
|
||||
---
|
||||
|
||||
## 15. 参考资料与索引
|
||||
|
||||
- 来源索引:见 `materials_index.md`
|
||||
- CODEMAP/DOMAINMAP/RUNTIME 引用:见第 14 章
|
||||
|
||||
---
|
||||
|
||||
## 图表要求(强制检查)
|
||||
|
||||
- [ ] 至少 1 个 mermaid 图(流程图/时序图/状态图任选)
|
||||
- [ ] 至少 1 张表(范围清单/风险列表/需求拆解等)
|
||||
- [ ] 端覆盖矩阵已填写(第 6.1 节)
|
||||
- [ ] 差异点清单已填写(第 8 章)
|
||||
- [ ] FR→AC 覆盖矩阵已填写(第 13 章)
|
||||
@@ -0,0 +1,108 @@
|
||||
# 会话状态报告模板(pmassist-v3)
|
||||
|
||||
> 用于会话恢复时自动生成状态报告。填充时读取相关文件提取数据。
|
||||
|
||||
## 报告模板
|
||||
|
||||
```markdown
|
||||
📊 会话状态报告
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
📁 工作目录:{workdir}
|
||||
📄 文档类型:{doc_type}
|
||||
📌 项目简称:{project_alias}
|
||||
📋 文档标题:{document_title}
|
||||
🔢 当前 Round:{current_round}
|
||||
📊 会话状态:{session_status}
|
||||
|
||||
📝 已完成内容:
|
||||
- 章节:{completed_chapters}/{total_chapters}
|
||||
- 功能需求(FR):{fr_count} 条
|
||||
- 验收标准(AC):{ac_count} 条(覆盖 {ac_coverage})
|
||||
- 证据映射:{evidence_count} 条
|
||||
- Mermaid 图:{mermaid_count} 个
|
||||
- 表格:{table_count} 个
|
||||
|
||||
❓ 遗留问题:
|
||||
- P0(阻塞):{p0_count} 个
|
||||
- P1(关键):{p1_count} 个
|
||||
- P2(细节):{p2_count} 个
|
||||
|
||||
🎨 原型状态:{proto_status}
|
||||
- 技术路径:{tech_stack}
|
||||
- 产出文件:{proto_outputs}
|
||||
|
||||
⏰ 会话时间:
|
||||
- 创建时间:{created_at}
|
||||
- 上次更新:{last_updated_at}
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
💡 建议工作模式:
|
||||
- [A] 继续模式(补充未完成章节)
|
||||
- [B] 修改模式(新需求/变更修订)
|
||||
- [C] 局部模式(快速修改单章节)
|
||||
- [D] 原型模式(更新/生成原型)
|
||||
- [E] 定稿模式(最终审核定稿)
|
||||
- [F] AC 生成模式(批量补充验收标准)✨ v3 新增
|
||||
```
|
||||
|
||||
## 数据来源映射
|
||||
|
||||
### 从 session.yaml 提取
|
||||
|
||||
```yaml
|
||||
project_alias, doc_type, title, round, status,
|
||||
fr_count, ac_count, ac_coverage,
|
||||
unresolved_questions, prototype.*
|
||||
```
|
||||
|
||||
### 从 outputs/{doc_type}.md 提取
|
||||
|
||||
```
|
||||
章节数:grep "^## " | wc -l
|
||||
Mermaid图:grep "```mermaid" | wc -l
|
||||
表格:grep "^|" | wc -l
|
||||
证据标注:grep "\[SRC-\|CODEMAP:\|DOMAINMAP:\|ASSUMPTION\]" | wc -l
|
||||
FR条数:grep "^#### FR-" | wc -l
|
||||
```
|
||||
|
||||
### 从 outputs/acceptance.md 提取
|
||||
|
||||
```
|
||||
AC条数:grep "^### AC-" | wc -l
|
||||
```
|
||||
|
||||
### 从 questions/round_*.yaml 提取
|
||||
|
||||
```
|
||||
P0未答数:grep "priority: P0" + "status: pending"
|
||||
P1未答数:grep "priority: P1" + "status: pending"
|
||||
P2未答数:grep "priority: P2" + "status: pending"
|
||||
```
|
||||
|
||||
## 健康度评估规则
|
||||
|
||||
**🟢 健康(可继续或定稿)**
|
||||
- P0 问题 = 0
|
||||
- 证据覆盖率 >= 80%
|
||||
- FR→AC 覆盖率 >= 80%
|
||||
|
||||
**🟡 警告(需注意)**
|
||||
- P0 问题 1-2 个
|
||||
- 证据覆盖率 50%-80%
|
||||
- FR→AC 覆盖率 50%-80%
|
||||
|
||||
**🔴 阻塞(需修复)**
|
||||
- P0 问题 >= 3 个
|
||||
- 证据覆盖率 < 50%
|
||||
- 缺少必备文件
|
||||
|
||||
## 工作模式推荐规则
|
||||
|
||||
| 条件 | 推荐模式 |
|
||||
|---|---|
|
||||
| 当前 Round 未完成 / 存在遗留问题 | [A] 继续模式 |
|
||||
| 用户提出新需求 / 重写章节 | [B] 修改模式 |
|
||||
| 只微调单章节 / 修正错误 | [C] 局部模式 |
|
||||
| prototype.enabled=true / 用户要求原型 | [D] 原型模式 |
|
||||
| P0/P1=0 / 用户确认定稿 | [E] 定稿模式 |
|
||||
| FR 有但 AC 覆盖不足(<80%) | [F] AC 生成模式 |
|
||||
Reference in New Issue
Block a user