feat: 根目录文档、脚本、gitignore
This commit is contained in:
@@ -0,0 +1,306 @@
|
||||
# v2.1.0 会话恢复功能完成清单
|
||||
|
||||
## 实施日期: 2026-02-09
|
||||
|
||||
---
|
||||
|
||||
## ✅ Task 1: 更新 SKILL.md 增加 1.5 会话恢复章节
|
||||
|
||||
**文件**: `/Users/HHH/Code/SIMA/skills/pmassist/SKILL.md`
|
||||
|
||||
**变更内容**:
|
||||
- 在第 1 节（确认工作目录）与第 2 节（初始化工作区）之间插入 `## 1.5) 会话恢复（Resume Session）`
|
||||
- 新增内容包括：
|
||||
- 触发条件（6 种自然语言触发方式）
|
||||
- 验证会话有效性（必备文件检查）
|
||||
- 状态回顾（自动生成报告模板）
|
||||
- 询问工作模式（5 种模式：A-E）
|
||||
- 工作模式执行流程（详细步骤）
|
||||
- 特殊处理（版本升级、损坏会话恢复）
|
||||
|
||||
**验证**:
|
||||
```bash
|
||||
grep -A 1 "## 1.5)" skills/pmassist/SKILL.md
|
||||
# 输出: ## 1.5) 会话恢复（Resume Session）
|
||||
```
|
||||
|
||||
**状态**: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
## ✅ Task 2: 创建 session_status_template.md 状态报告模板
|
||||
|
||||
**文件**: `/Users/HHH/Code/SIMA/skills/pmassist/references/session_status_template.md`
|
||||
|
||||
**内容结构**:
|
||||
- **基础信息模板**：工作目录、文档类型、Round、状态、章节、问题、原型
|
||||
- **数据来源映射**：从 session.yaml、summary.md、outputs/*.md、questions/*.yaml 提取数据
|
||||
- **状态诊断规则**：健康度评估（🟢🟡🔴）、建议工作模式
|
||||
- **报告输出示例**：3 个完整示例（进行中 PRD、接近定稿 FRD、损坏会话）
|
||||
|
||||
**验证**:
|
||||
```bash
|
||||
cat skills/pmassist/references/session_status_template.md | head -5
|
||||
# 输出: # 会话状态报告模板...
|
||||
```
|
||||
|
||||
**状态**: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
## ✅ Task 3: 更新 SKILL.md 资源章节
|
||||
|
||||
**文件**: `/Users/HHH/Code/SIMA/skills/pmassist/SKILL.md`
|
||||
|
||||
**变更内容**:
|
||||
- 重组资源章节，分为 4 个子类：
|
||||
- 脚本（init_session.py）
|
||||
- 文档模板（PRD/FRD/DAR）
|
||||
- 原型相关模板（proto_requirements、prototype_coverage）
|
||||
- 会话恢复模板（session_status_template）
|
||||
|
||||
**验证**:
|
||||
```bash
|
||||
grep "session_status_template" skills/pmassist/SKILL.md
|
||||
# 输出: - **状态报告模板**：`references/session_status_template.md`
|
||||
```
|
||||
|
||||
**状态**: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
## ✅ Task 4: 更新 CHANGELOG.md 记录 v2.1.0 变更
|
||||
|
||||
**文件**: `/Users/HHH/Code/SIMA/skills/pmassist/CHANGELOG.md`
|
||||
|
||||
**内容**:
|
||||
- 新增 `[v2.1.0] - 2026-02-09` 版本记录
|
||||
- 核心特性：自动状态回顾、5 种工作模式、触发词识别、版本升级检测
|
||||
- 文件变更详情：SKILL.md 新增 1.5 节
|
||||
- 5 种工作模式详细说明：Continue/Revise/Patch/Prototype/Finalize
|
||||
- 状态报告模板示例
|
||||
- 使用场景（5 个完整场景示例）
|
||||
- 向后兼容说明
|
||||
|
||||
**验证**:
|
||||
```bash
|
||||
grep "v2.1.0" skills/pmassist/CHANGELOG.md
|
||||
# 输出: ## [v2.1.0] - 2026-02-09
|
||||
```
|
||||
|
||||
**状态**: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
## 功能验证
|
||||
|
||||
### 5 种工作模式清单
|
||||
|
||||
- [x] **A. 继续模式**（Continue）
|
||||
- 接续当前 Round，补充未完成章节
|
||||
- 优先解决 P0 遗留问题
|
||||
- 继续执行 PDCA 循环
|
||||
|
||||
- [x] **B. 修改模式**（Revise）
|
||||
- 开启新 Round（N+1），基于新需求修订
|
||||
- 重新走一轮完整 PDCA
|
||||
- 记录修改诉求到新 round 文件
|
||||
|
||||
- [x] **C. 局部模式**（Patch）
|
||||
- 只修改特定章节/段落，不开启新 Round
|
||||
- 不触发完整 PDCA，快速修改
|
||||
- 追加修改记录到 decision_log.md
|
||||
|
||||
- [x] **D. 原型模式**（Prototype）
|
||||
- 独立于文档迭代，执行 Proto Round 1-3
|
||||
- 支持更新/重新生成原型
|
||||
- 与 2.6 节原型设计环节联动
|
||||
|
||||
- [x] **E. 定稿模式**（Finalize）
|
||||
- 最终审核并定稿，不再修改内容
|
||||
- 完整性检查（证据覆盖、图表齐全、问题清零）
|
||||
- 生成 `{doc_type}_final.md` 并更新状态
|
||||
|
||||
### 触发条件验证
|
||||
|
||||
- [x] "继续之前的工作"
|
||||
- [x] "修改 XXX 的 PRD/FRD/DAR"
|
||||
- [x] "重新编辑 {workdir} 的文档"
|
||||
- [x] "在 {workdir} 基础上调整"
|
||||
- [x] 用户直接提供工作目录路径
|
||||
|
||||
### 状态报告完整性
|
||||
|
||||
- [x] 基础信息（工作目录、文档类型、Round、状态）
|
||||
- [x] 已完成内容（章节数、证据数、图表数）
|
||||
- [x] 遗留问题（P0/P1/P2 统计）
|
||||
- [x] 原型状态（启用状态、Proto Round、技术路径、产出文件）
|
||||
- [x] 会话时间（创建时间、上次更新）
|
||||
|
||||
### 特殊处理
|
||||
|
||||
- [x] 会话版本升级（v1.x → v2.x）
|
||||
- [x] 损坏会话恢复（重建或放弃）
|
||||
- [x] 健康度诊断（🟢🟡🔴）
|
||||
- [x] 自动推荐工作模式
|
||||
|
||||
---
|
||||
|
||||
## 文件清单
|
||||
|
||||
| 文件路径 | 类型 | 状态 |
|
||||
|---|---|---|
|
||||
| `skills/pmassist/SKILL.md` | 核心文档 | ✅ 已更新（新增 1.5 节 + 资源章节） |
|
||||
| `skills/pmassist/references/session_status_template.md` | 模板 | ✅ 新建 |
|
||||
| `skills/pmassist/CHANGELOG.md` | 版本记录 | ✅ 已更新（新增 v2.1.0） |
|
||||
| `skills/pmassist/V2.1-SESSION-RESUMPTION-CHECKLIST.md` | 本文件 | ✅ 新建 |
|
||||
|
||||
---
|
||||
|
||||
## 设计原则
|
||||
|
||||
### ✅ 轻量级实现
|
||||
- 无需额外脚本，Claude 手动读取文件并生成报告
|
||||
- 利用现有工具（Read、Bash）完成所有操作
|
||||
- 快速可用，无额外依赖
|
||||
|
||||
### ✅ 明确模式
|
||||
- 5 种模式覆盖所有工作场景，避免混淆
|
||||
- 每种模式有清晰的触发条件和执行流程
|
||||
- 用户可根据需求自由选择
|
||||
|
||||
### ✅ 状态透明
|
||||
- 报告模板清晰展示会话状态
|
||||
- 健康度诊断辅助决策
|
||||
- 自动推荐最合适的工作模式
|
||||
|
||||
### ✅ 灵活切换
|
||||
- 支持多种触发方式（路径、自然语言）
|
||||
- 可在不同模式间灵活切换
|
||||
- 支持版本升级和损坏恢复
|
||||
|
||||
---
|
||||
|
||||
## 使用场景覆盖
|
||||
|
||||
### 场景 1：继续未完成工作 ✅
|
||||
```
|
||||
用户："继续 dual-billing-20260209-1500 的 PRD"
|
||||
Claude：读取 → 生成报告 → 推荐 [A] 继续模式
|
||||
```
|
||||
|
||||
### 场景 2：基于新需求修改 ✅
|
||||
```
|
||||
用户："修改 dual-billing 的计费逻辑，增加时长计费"
|
||||
Claude：读取 → 生成报告 → 推荐 [B] 修改模式（开启 Round N+1）
|
||||
```
|
||||
|
||||
### 场景 3：快速修正单章节 ✅
|
||||
```
|
||||
用户："把 dual-billing PRD 的第 3 章重写一下"
|
||||
Claude：读取 → 生成报告 → 推荐 [C] 局部模式
|
||||
```
|
||||
|
||||
### 场景 4：更新原型 ✅
|
||||
```
|
||||
用户："dual-billing 的原型需要增加一个结算页面"
|
||||
Claude：读取 → 生成报告 → 推荐 [D] 原型模式（Proto Round 增量）
|
||||
```
|
||||
|
||||
### 场景 5：最终定稿 ✅
|
||||
```
|
||||
用户："dual-billing PRD 可以定稿了"
|
||||
Claude：读取 → 生成报告 → 推荐 [E] 定稿模式
|
||||
```
|
||||
|
||||
### 场景 6：版本升级 ✅
|
||||
```
|
||||
检测 v1.x 会话 → 提示升级到 v2.0
|
||||
用户选择 [Y] → 自动增加 prototype 配置块
|
||||
```
|
||||
|
||||
### 场景 7：损坏会话 ✅
|
||||
```
|
||||
检测缺失必备文件 → 显示损坏报告
|
||||
提供 [A] 重建 或 [B] 创建新会话
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 向后兼容
|
||||
|
||||
- ✅ v1.x 会话可自动识别并提示升级
|
||||
- ✅ 不影响现有新建会话流程（第 1-2 节）
|
||||
- ✅ 所有恢复功能为可选，不破坏原有工作流
|
||||
- ✅ 与 v2.0.0 原型功能完全兼容
|
||||
|
||||
---
|
||||
|
||||
## 与 v2.0.0 的关系
|
||||
|
||||
**v2.0.0**（原型设计）:
|
||||
- 新增 2.6 原型设计环节
|
||||
- 支持 `--enable-prototype` 参数
|
||||
- Proto Round 1-3 流程
|
||||
|
||||
**v2.1.0**（会话恢复）:
|
||||
- 新增 1.5 会话恢复流程
|
||||
- 5 种工作模式（包含原型模式 D）
|
||||
- 与原型功能无缝集成
|
||||
|
||||
**关系**:
|
||||
- v2.1.0 完全兼容 v2.0.0
|
||||
- 原型模式（D）调用 2.6 节的 Proto Round 流程
|
||||
- 状态报告包含原型状态字段
|
||||
- 可恢复已启用原型的会话
|
||||
|
||||
---
|
||||
|
||||
## 下一步建议
|
||||
|
||||
### P1 任务（可选）
|
||||
|
||||
1. **创建实战测试**:
|
||||
- 用 `dual-billing` 项目测试会话恢复流程
|
||||
- 测试 5 种工作模式的实际效果
|
||||
- 收集用户反馈优化报告模板
|
||||
|
||||
2. **补充用户文档**:
|
||||
- 创建"会话恢复用户指南"（`guides/session-resumption.md`）
|
||||
- 补充"工作模式选择决策树"
|
||||
- 增加常见问题 FAQ
|
||||
|
||||
3. **增强状态诊断**:
|
||||
- 完善健康度评估算法
|
||||
- 增加"证据覆盖率"自动计算
|
||||
- 支持"修改影响分析"
|
||||
|
||||
### P2 任务（优化迭代）
|
||||
|
||||
- [ ] 支持会话快照（保存特定时间点的状态）
|
||||
- [ ] 自动备份机制（`.backup/` 目录）
|
||||
- [ ] 多会话对比报告（对比不同版本的变更）
|
||||
- [ ] 会话归档与检索（已定稿会话的管理）
|
||||
|
||||
---
|
||||
|
||||
## 总结
|
||||
|
||||
所有 v2.1.0 会话恢复功能已按计划完成，轻量级实现方案已成功集成到 pmassist 技能中。
|
||||
|
||||
**核心成果**:
|
||||
- ✅ 1 个文件更新（SKILL.md 新增 1.5 节 + 资源章节）
|
||||
- ✅ 2 个新文件创建（session_status_template.md、本清单）
|
||||
- ✅ 1 个文件更新（CHANGELOG.md 新增 v2.1.0）
|
||||
- ✅ 完整的 5 种工作模式设计
|
||||
- ✅ 轻量级实现，无需额外脚本
|
||||
- ✅ 完整的文档和使用场景
|
||||
|
||||
**准备就绪**: pmassist v2.1.0 可以开始投入使用！
|
||||
|
||||
---
|
||||
|
||||
**实施者**: Claude Code (Sonnet 4.5)
|
||||
**完成时间**: 2026-02-09 17:30:00
|
||||
**审核状态**: ✅ 待用户验收
|
||||
**实施方式**: 选项 A - 轻量级实现（手动）
|
||||
Reference in New Issue
Block a user