feat: 根目录文档、脚本、gitignore
This commit is contained in:
@@ -0,0 +1,148 @@
|
||||
# pmassist-v3 Changelog
|
||||
|
||||
## [v3.0.0] - 2026-03-30
|
||||
|
||||
### 基于 pmassist v2.1 全面升级
|
||||
|
||||
#### 核心新增特性
|
||||
|
||||
---
|
||||
|
||||
##### 1. FR 功能需求追踪体系（第 3.6 节）
|
||||
|
||||
**背景**：v2.x 的"需求内容"章节缺乏结构化编号，导致追踪困难。
|
||||
**改进**：
|
||||
- 所有功能需求使用 `FR-xxx` 编号（主功能 FR-001 / 子场景 FR-001-1）
|
||||
- FR 记录包含：优先级、角色、触发条件（WHEN/IF）、需求（SHALL）、业务规则、AC 引用
|
||||
- `session.yaml` 新增 `fr_count` / `ac_count` / `ac_coverage` 统计字段
|
||||
|
||||
---
|
||||
|
||||
##### 2. AC 验收标准管理（第 3.7 节）
|
||||
|
||||
**背景**：v2.x 缺乏结构化验收标准，PRD 无法直接驱动测试。
|
||||
**改进**：
|
||||
- AC 编号规则：`AC-{FR编号后缀}-{序号}`（如 AC-001-1）
|
||||
- 格式固定为 Given / When / Then
|
||||
- 每条 FR 至少要求：1条正常路径 + 1条异常路径
|
||||
- 独立输出到 `outputs/acceptance.md`
|
||||
- 主文档末尾维护 FR→AC 覆盖矩阵
|
||||
|
||||
---
|
||||
|
||||
##### 3. AC 生成模式（会话恢复 F 模式）
|
||||
|
||||
**背景**：批量生成/补全验收标准的需求
|
||||
**改进**：
|
||||
- 新增 F. AC 生成模式（Acceptance）
|
||||
- 基于现有 FR 列表批量生成 Given/When/Then 验收标准
|
||||
- 支持一键补全 AC 覆盖缺口
|
||||
|
||||
---
|
||||
|
||||
##### 4. 端/渠道覆盖矩阵强化（PRD 第 6.1 节）
|
||||
|
||||
**背景**：多端产品需要明确各端覆盖情况
|
||||
**改进**：
|
||||
- 端覆盖矩阵新增"涉及 FR"列，双向追踪
|
||||
- Check 阶段强制验证矩阵是否填写
|
||||
|
||||
---
|
||||
|
||||
##### 5. 差异点清单增强（PRD 第 8 章）
|
||||
|
||||
**背景**：v2.x 差异清单维度不够
|
||||
**改进**：
|
||||
- 新增"数据结构差异"和"权限差异"维度
|
||||
- 新增"涉及 FR"列，与需求直接关联
|
||||
|
||||
---
|
||||
|
||||
##### 6. 数据模型输出规范（第 9 节）
|
||||
|
||||
**背景**：实际 PRD 产出中 DDL 规范不统一
|
||||
**改进**：
|
||||
- 标准化 CREATE TABLE 模板（含 del_flag/create_by/update_by 等标准字段）
|
||||
- 标准化 ALTER TABLE 字段新增格式
|
||||
- PRD 中作为"建议数据结构"，FRD 中作为"规格要求"
|
||||
|
||||
---
|
||||
|
||||
##### 7. 变更管理规范（第 10 节）
|
||||
|
||||
**背景**：PRD 迭代时变更追踪不够系统
|
||||
**改进**：
|
||||
- `decision_log.md` 表格新增"变更编号"（CHG-xxx）和"影响 FR"列
|
||||
- 明确版本命名规范：v1.0 → v1.x → v1.x Final → v2.0
|
||||
|
||||
---
|
||||
|
||||
##### 8. 智能内联问答（第 5.5 节）
|
||||
|
||||
**背景**：用户同一条消息中给出需求+部分答案时，AI 重复追问体验差
|
||||
**改进**：
|
||||
- 直接消化已给出的答案，只追问真正不确定的 P0/P1 问题
|
||||
- `session.yaml` 新增 `skip_flags` 字段记录用户主动跳过的模块
|
||||
|
||||
---
|
||||
|
||||
##### 9. PDCA Check 阶段增强（第 4 节）
|
||||
|
||||
**背景**：v2.x Check 缺乏对新增结构的验证
|
||||
**新增检查项**：
|
||||
- FR 编号连续性
|
||||
- AC 覆盖率（每条 FR 至少 1 AC）
|
||||
- 端覆盖矩阵是否填写
|
||||
- 差异点清单是否完整
|
||||
|
||||
---
|
||||
|
||||
#### 模板文件更新
|
||||
|
||||
| 文件 | 变更说明 |
|
||||
|---|---|
|
||||
| `references/prd.md` | 新增 FR 列表、FR→AC 矩阵、端覆盖矩阵、差异点新维度、数据模型章节、变更记录表 |
|
||||
| `references/frd.md` | 新增 FR 编号格式、DDL 规范、FR→AC 矩阵、差异点清单、变更记录表 |
|
||||
| `references/dar.md` | 新增 5-Whys 表格、代码根因定位表、可复用检查项清单 |
|
||||
| `references/acceptance_template.md` | 新增（v3）：Given/When/Then 验收标准模板 |
|
||||
| `references/session_template.yaml` | 新增（v3）：fr_count / ac_count / ac_coverage / skip_flags 字段 |
|
||||
| `scripts/init_session.py` | 新增 `--enable-acceptance` 参数，自动创建 acceptance.md |
|
||||
|
||||
---
|
||||
|
||||
#### 向后兼容
|
||||
|
||||
- ✅ v2.x 会话可继续使用（缺少 FR/AC 统计字段时提示升级）
|
||||
- ✅ 未使用 `--enable-prototype` 时，行为与 v2.x 完全一致
|
||||
- ✅ 所有新增功能均为可选增强，不破坏现有工作流
|
||||
|
||||
---
|
||||
|
||||
#### 升级指南（v2.x → v3.0）
|
||||
|
||||
1. 在 `session.yaml` 中添加：
|
||||
```yaml
|
||||
fr_count: 0
|
||||
ac_count: 0
|
||||
ac_coverage: "0/0"
|
||||
skip_flags:
|
||||
prototype: false
|
||||
ac_batch: false
|
||||
diff_list: false
|
||||
```
|
||||
2. 创建 `outputs/acceptance.md`（如需要）
|
||||
3. 在主文档中为现有功能需求补充 FR-xxx 编号和 AC 引用
|
||||
|
||||
---
|
||||
|
||||
## [v2.1.0] - 2026-02-09
|
||||
|
||||
> 详见 pmassist 原版 CHANGELOG：新增会话恢复（Session Resumption）、5 种工作模式（A-E）
|
||||
|
||||
## [v2.0.0] - 2026-02-09
|
||||
|
||||
> 详见 pmassist 原版 CHANGELOG：新增原型设计环节（Proto Round 1-3）
|
||||
|
||||
## [v1.0.0] - 2026-02-08
|
||||
|
||||
> 详见 pmassist 原版 CHANGELOG：初始版本，WWH + PDCA 工作流程
|
||||
Reference in New Issue
Block a user