feat: 根目录文档、脚本、gitignore

2026-10-08 16:15:33 +08:00
commit e98660ce4e
284 changed files with 26838 additions and 0 deletions
@@ -0,0 +1,262 @@
+# 会话状态报告模板
+
+> 用于会话恢复时自动生成状态报告。Claude 读取相关文件后填充此模板。
+
+## 基础信息
+
+```markdown
+📊 会话状态报告
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+📁 工作目录：{workdir}
+📄 文档类型：{doc_type}  # PRD / FRD / DAR
+📌 项目简称：{project_alias}
+📋 文档标题：{document_title}
+🔢 当前 Round：{current_round}
+📊 会话状态：{session_status}  # in_progress / pending_review / finalized
+
+📝 已完成内容：
+   - 章节：{completed_chapters}/{total_chapters}
+   - 证据映射：{evidence_count} 条
+   - Mermaid 图：{mermaid_count} 个
+   - 表格：{table_count} 个
+
+❓ 遗留问题：
+   - P0（阻塞）：{p0_count} 个
+   - P1（关键）：{p1_count} 个
+   - P2（细节）：{p2_count} 个
+
+🎨 原型状态：{proto_status}  # proto_pending / proto_in_progress / proto_complete / disabled
+   - 启用状态：{proto_enabled}  # true / false
+   - Proto Round：{proto_round}  # 0 / 1 / 2 / 3
+   - 技术路径：{tech_stack}  # ["Pencil"] / ["Web Artifact"] / ["Pencil", "Web Artifact"]
+   - 产出文件：
+     {proto_output_list}
+   - 未解决问题：{proto_unresolved_count} 个
+
+⏰ 会话时间：
+   - 创建时间：{created_at}
+   - 上次更新：{last_updated_at}
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+## 数据来源映射
+
+### 从 session.yaml 提取
+```yaml
+workdir: {path}
+doc_type: {prd/frd/dar}
+project_alias: {alias}
+current_round: {round}
+session_status: {status}
+unresolved_questions:
+  - id: P0-1-1  # 统计 P0/P1/P2
+prototype:
+  enabled: {true/false}
+  status: {proto_status}
+  proto_round: {0-3}
+  tech_stack: [...]
+  outputs: [...]
+  unresolved_proto_questions: [...]
+created_at: {timestamp}
+last_updated_at: {timestamp}
+```
+
+### 从 summary.md 提取
+- 快速回顾已完成的主要内容
+- 提取关键进展摘要
+
+### 从 outputs/{doc_type}.md 提取
+```bash
+# 统计章节数
+grep "^## " outputs/prd.md | wc -l
+
+# 统计 Mermaid 图
+grep "```mermaid" outputs/prd.md | wc -l
+
+# 统计表格
+grep "^|" outputs/prd.md | wc -l
+
+# 统计证据标注
+grep "\[.*:.*\]" outputs/prd.md | wc -l
+```
+
+### 从 questions/round_*.yaml 提取
+```bash
+# 统计遗留问题
+grep "priority: P0" questions/round_*.yaml | wc -l
+grep "priority: P1" questions/round_*.yaml | wc -l
+grep "priority: P2" questions/round_*.yaml | wc -l
+
+# 过滤已回答的问题（answer 不为空）
+```
+
+### 从 prototypes/ 目录提取
+```bash
+# 检查原型文件存在性
+ls prototypes/*.pen 2>/dev/null
+ls prototypes/webapp/index.html 2>/dev/null
+ls prototypes/screenshots/*.png 2>/dev/null
+```
+
+## 状态诊断规则
+
+### 健康度评估
+
+**🟢 健康（可继续）**
+- P0 问题 = 0
+- 证据覆盖率 >= 80%
+- 所有章节至少 1 条证据或 `[ASSUMPTION]`
+
+**🟡 警告（需注意）**
+- P0 问题 1-2 个
+- 证据覆盖率 50%-80%
+- 部分章节缺少图表
+
+**🔴 阻塞（需修复）**
+- P0 问题 >= 3 个
+- 证据覆盖率 < 50%
+- 缺少必备文件（session.yaml/desc.md）
+
+### 建议工作模式
+
+**推荐 [A] 继续模式**：
+- 当前 Round 未完成
+- 存在遗留问题待解答
+- 章节完成度 < 100%
+
+**推荐 [B] 修改模式**：
+- 用户明确提出新需求
+- 需要重写已完成章节
+- 证据源发生重大变化
+
+**推荐 [C] 局部模式**：
+- 只需微调单个章节
+- 修正文字错误/格式问题
+- 补充遗漏的证据标注
+
+**推荐 [D] 原型模式**：
+- prototype.enabled = true
+- 用户要求更新原型
+- 新增界面/交互需求
+
+**推荐 [E] 定稿模式**：
+- current_round >= 3
+- P0/P1 问题 = 0
+- 证据覆盖率 = 100%
+- 用户明确说"可以定稿"
+
+## 报告输出示例
+
+### 示例 1：进行中的 PRD
+
+```markdown
+📊 会话状态报告
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+📁 工作目录：./dual-billing-20260209-1500
+📄 文档类型：PRD
+📌 项目简称：dual-billing
+📋 文档标题：双计费模式产品需求文档
+🔢 当前 Round：2
+📊 会话状态：in_progress
+
+📝 已完成内容：
+   - 章节：3/7（已完成：业务背景、用户故事、功能清单）
+   - 证据映射：12 条
+   - Mermaid 图：1 个（用户流程图）
+   - 表格：2 个（功能优先级、角色权限）
+
+❓ 遗留问题：
+   - P0（阻塞）：0 个
+   - P1（关键）：5 个（计费规则细节、异常处理）
+   - P2（细节）：3 个（UI 交互、提示文案）
+
+🎨 原型状态：proto_pending
+   - 启用状态：true
+   - Proto Round：0（尚未开始）
+   - 技术路径：[]
+   - 产出文件：无
+   - 未解决问题：0 个
+
+⏰ 会话时间：
+   - 创建时间：2026-02-09 10:30
+   - 上次更新：2026-02-09 14:20
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+💡 建议工作模式：
+- [A] 继续模式 ✨ **推荐**（解决 5 个 P1 问题并补充第 4-7 章）
+- [B] 修改模式（如有新需求变更）
+- [D] 原型模式（先完成原型再继续文档）
+```
+
+### 示例 2：接近定稿的 FRD
+
+```markdown
+📊 会话状态报告
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+📁 工作目录：./order-refactor-20260208-0900
+📄 文档类型：FRD
+📌 项目简称：order-refactor
+📋 文档标题：订单模块重构功能规格书
+🔢 当前 Round：5
+📊 会话状态：pending_review
+
+📝 已完成内容：
+   - 章节：10/10（全部完成）
+   - 证据映射：38 条
+   - Mermaid 图：5 个（时序图、状态机、ER 图）
+   - 表格：8 个（接口定义、数据字典、状态流转）
+
+❓ 遗留问题：
+   - P0（阻塞）：0 个
+   - P1（关键）：0 个
+   - P2（细节）：1 个（日志格式规范）
+
+🎨 原型状态：proto_complete
+   - 启用状态：true
+   - Proto Round：3（已完成）
+   - 技术路径：["Pencil", "Web Artifact"]
+   - 产出文件：
+     - prototypes/order_flow.pen
+     - prototypes/webapp/index.html
+     - prototypes/screenshots/order_detail.png
+     - prototypes/prototype_coverage.md
+   - 未解决问题：0 个
+
+⏰ 会话时间：
+   - 创建时间：2026-02-08 09:00
+   - 上次更新：2026-02-09 16:45
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+💡 建议工作模式：
+- [E] 定稿模式 ✨ **推荐**（解决 1 个 P2 问题后可定稿）
+- [C] 局部模式（快速补充日志规范）
+```
+
+### 示例 3：损坏的会话
+
+```markdown
+⚠️ 会话验证失败
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+📁 工作目录：./broken-session-20260201-1000
+❌ 缺失文件：
+   - session.yaml（必备）
+   - summary.md（必备）
+
+✅ 存在文件：
+   - desc.md
+   - outputs/prd.md（可能不完整）
+   - materials/（部分资料）
+
+💡 恢复选项：
+- [A] 基于现有文件重建 session.yaml（需手动填充元数据）
+- [B] 放弃恢复，创建新会话（建议）
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+```
+
+## 使用说明
+
+1. **触发时机**：用户提供已存在工作目录路径时立即读取文件并生成报告
+2. **必读文件**：session.yaml、summary.md、questions/*.yaml、outputs/*.md
+3. **可选文件**：prototypes/*（如果启用原型）
+4. **输出格式**：使用上述模板，填充实际数据
+5. **模式建议**：根据状态诊断规则自动推荐工作模式