prd-workflow-cli 1.4.1 → 2.0.0

package/README.md

@@ -1,458 +1,266 @@
 # PRD Workflow CLI
 
 > 产品需求管理规范命令行工具  
-> 基于 A→R→B→C 流程的严格需求管理系统
+> 基于 **基线→规划→IT→版本** 流程的需求管理系统
 
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 ![Node](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen.svg)
+![Version](https://img.shields.io/badge/version-2.0.0-blue.svg)
 
-## 📖 简介
-
-这是一个基于严格产品需求管理规范的 CLI 工具,帮助产品团队和 AI 编程助手按照规范化流程完成需求管理工作。
-
-### 核心特点
-
-✅ **强制审视机制** - R1/R2 作为"闸门",必须通过才能进入下一阶段  
-✅ **文档模板化** - 每个阶段都有明确的文档结构和填写指引  
-✅ **AI 可执行** - 配合 Cursor、Codeium 等 AI IDE 使用  
-✅ **阶段清晰** - A(基线) → R(审视) → B(规划) → C(版本) 流程明确  
-✅ **防止失控** - 通过强制约束防止规划膨胀和需求蔓延  
+---
 
-## 🎯 核心理念
+## 📖 目录
 
-### 工作流程
+- [简介](#-简介)
+- [快速开始](#-快速开始)
+- [核心工作流程](#-核心工作流程)
+- [文档体系](#-文档体系)
+- [命令参考](#-命令参考)
+- [与 AI IDE 集成](#-与-ai-ide-集成)
+- [FAQ](#-faq)
 
-```
-A 类(现状基线)
-    ↓
-R1 启动条件检查 → 不通过则停止
-    ↓ 通过
-B1/B2(需求规划)
-    ↓
-R1 规划审视 → 不通过则返回修改
-    ↓ 通过
-B3(规划冻结)
-    ↓
-C0/C1(版本需求)
-    ↓
-R2 版本审视 → 不通过则返回修改
-    ↓ 通过
-C3(版本冻结)
-```
+---
 
-### 关键原则
+## 🎯 简介
 
-1. **R1 是启动闸门**: 必须满足三个条件才能开始规划
-   - 问题真实存在(基于 A 类现状)
-   - 值得单独规划(不是小修小补)
-   - 问题已理解清楚(不用规划来想问题)
+PRD-CLI 是一套**规范化的产品需求管理工具**，解决的核心问题：
 
-2. **B3 是决策冻结**: 规划一旦冻结不可随意更改
+> 让 AI 从"陪你写需求"变成"帮你挡住不该写的需求"
 
-3. **C 类不讨论方向**: 只执行已冻结的规划，不再讨论"该不该做"
+### 核心价值
 
-4. **审视是强制的**: R1/R2 必须通过才能进入下一阶段
+- **防止幻觉** - AI 不编造 API/SQL/算法，技术细节由技术负责人确认
+- **防止越界** - 每个阶段有明确边界，防止需求蔓延
+- **对话驱动** - 文档通过对话逐步完成，而非一次性填充
 
-## 🚀 安装
+---
 
-### 方式1：npx 直接运行（无需安装）✨
+## 🚀 快速开始
 
-无需全局安装，直接使用 npx 运行任何命令：
+### 安装
 
 ```bash
-# 初始化新项目（推荐）
-npx -y prd-workflow-cli@latest init 我的项目
-
-# 或者进入空目录直接初始化
-mkdir 我的项目 && cd 我的项目
-npx -y prd-workflow-cli@latest
-
-# 查看帮助
-npx prd-workflow-cli@latest --help
-
-# 规则校验 (v1.4.0 新增)
-npx prd-workflow-cli@latest check
-
-# 统计报告 (v1.4.0 新增)
-npx prd-workflow-cli@latest stats
+npm install -g prd-workflow-cli
 ```
 
-> 💡 **建议使用 `@latest` 确保使用最新版本**
-> 
-> ⚠️ 不加 `@latest` 可能使用缓存的旧版本
-
-### 方式2：全局安装（推荐频繁使用者）
+### 初始化项目
 
 ```bash
-npm install -g prd-workflow-cli
-
-# 验证安装
-prd --version  # 应该显示 1.4.0
-
-# 然后直接使用 prd 命令
-prd init 我的项目
-prd check
-prd stats
+prd init my-project
+cd my-project
 ```
 
-### 方式3：从源码安装
+### 核心流程
 
 ```bash
-git clone https://github.com/houtonghoutong/PRD-CLI.git
-cd PRD-CLI/prd-cli
-npm install
-npm link
-```
+# 1. 基线阶段 - 建立产品现状
+prd baseline create 产品定义    # PM 填写
+prd baseline create 代码快照    # AI 扫描生成
 
-## 📝 快速开始
+# 2. 规划阶段 - 确定要做什么
+prd iteration new               # 创建迭代
+prd plan create                 # 创建需求规划
+prd plan freeze                 # 冻结规划
 
-### 1. 初始化项目
+# 3. IT 阶段 - 细化用户故事
+prd it create "功能名称"        # 创建用户故事
 
-```bash
-# 使用 npx（推荐）
-npx prd-workflow-cli init my-product
-cd my-product
-npm install
-
-# 或者全局安装后使用
-prd init my-product
-cd my-product
-npm install
+# 4. 版本阶段 - 完成冻结
+prd version freeze              # 冻结版本，交付研发
 ```
 
-这将创建标准的目录结构:
+---
+
+## 🔄 核心工作流程
 
 ```
-my-product/
-├── 00_项目总览/
-│   └── P0_项目基本信息.md
-├── 01_产品基线/
-├── 02_迭代记录/
-├── 99_归档区/
-└── .agent/workflows/
+┌─────────────┐    ┌─────────────┐    ┌─────────────┐    ┌─────────────┐
+│   基线阶段   │ ─→ │   规划阶段   │ ─→ │   IT 阶段   │ ─→ │   版本阶段   │
+│             │    │             │    │             │    │             │
+│  产品定义    │    │  需求规划    │    │  业务需求    │    │  版本发布    │
+│  代码快照    │    │  规划冻结    │    │  技术规格    │    │             │
+│  用户反馈    │    │             │    │             │    │             │
+└─────────────┘    └─────────────┘    └─────────────┘    └─────────────┘
+      ↑                  ↑                  ↑                  ↑
+   PM+AI 填写       PM+AI 对话          PM+AI 对话          自动生成
 ```
 
-### 2. 建立产品基线(A 类文档)
+### 各阶段说明
 
-```bash
-# 创建基础文档
-prd baseline create A0  # 产品基础与范围说明
-prd baseline create A1  # 已上线功能与流程清单
-prd baseline create A2  # 存量反馈与数据汇总
-prd baseline create R0  # 基线审视报告
-```
+| 阶段 | 目的 | 产出 |
+|------|------|------|
+| **基线** | 建立产品现状基线 | 产品定义.md、代码快照.md、用户反馈.md |
+| **规划** | 确定本轮迭代目标 | 需求规划.md、规划冻结.md |
+| **IT** | 细化可执行的用户故事 | 业务需求.md、技术规格.md |
+| **版本** | 冻结需求，交付研发 | 版本发布.md |
 
-### 3. 开始第一轮迭代
+---
 
-```bash
-# 创建新迭代
-prd iteration new
+## 📁 文档体系
 
-# 这会创建 R1_规划启动条件检查.md
-# 填写并确认三个启动条件全部满足后，才能继续
+### 目录结构
+
+```
+项目目录/
+├── 00_项目总览/
+│   └── 项目信息.md              # 项目元信息
+├── 01_基线/
+│   ├── 产品定义.md              # PM 填写
+│   ├── 代码快照.md              # AI 扫描生成
+│   └── 用户反馈.md              # AI 整理
+├── 02_迭代记录/
+│   └── 第01轮迭代/
+│       ├── 需求规划.md          # PM+AI 对话
+│       ├── 规划冻结.md          # 自动生成
+│       ├── IT/
+│       │   └── IT-001-功能名/
+│       │       ├── 业务需求.md  # PM+AI 对话
+│       │       └── 技术规格.md  # 技术负责人补充
+│       └── 版本发布.md          # 自动生成
+└── 99_归档区/                   # 历史文档
 ```
 
-### 4. 需求规划(B 类文档)
+### 文档职责
 
-```bash
-# 创建规划文档
-prd plan create B1  # 需求规划草案
-prd plan create B2  # 规划拆解与范围界定
+| 文档 | 负责人 | 说明 |
+|------|--------|------|
+| 产品定义 | PM | 产品边界、红线约束 |
+| 代码快照 | AI | 扫描代码生成功能清单 |
+| 用户反馈 | PM/AI | 整理用户反馈和问题 |
+| 需求规划 | PM+AI | 对话确定规划目标 |
+| 规划冻结 | 系统 | `prd plan freeze` 自动生成 |
+| 业务需求 | PM+AI | 用户故事、验收标准 |
+| 技术规格 | 技术负责人 | 技术实现要点 |
+| 版本发布 | 系统 | `prd version freeze` 自动生成 |
 
-# 执行 R1 审视
-prd review r1
+---
 
-# 如果通过，冻结规划
-prd plan freeze  # 生成 B3 规划冻结归档
-```
+## ⌨️ 命令参考
 
-### 5. 版本需求(C 类文档)
+### 项目管理
 
 ```bash
-# 创建版本文档
-prd version create C0  # 版本范围声明
-prd version create C1  # 版本需求清单
-
-# 执行 R2 审视
-prd review r2
-
-# 如果通过，冻结版本
-prd version freeze  # 生成 C3 版本冻结归档
+prd init <项目名>          # 初始化项目
+prd status                 # 查看项目状态
+prd upgrade                # 更新工作流文件
 ```
 
-### 6. 查看项目状态
+### 基线管理
 
 ```bash
-prd status          # 查看当前项目状态
-prd iteration list  # 查看所有迭代
+prd baseline create 产品定义    # 创建产品定义
+prd baseline create 代码快照    # 创建代码快照
+prd baseline create 用户反馈    # 创建用户反馈
 ```
 
-## 📚 命令参考
-
-### 项目管理
-
-| 命令 | 说明 |
-|------|------|
-| `prd init <name>` | 初始化新项目 |
-| `prd status` | 查看项目状态 |
-
-### 基线管理(A 类)
-
-| 命令 | 说明 |
-|------|------|
-| `prd baseline create A0` | 创建产品基础与范围说明 |
-| `prd baseline create A1` | 创建已上线功能与流程清单 |
-| `prd baseline create A2` | 创建存量反馈与数据汇总 |
-| `prd baseline create R0` | 创建基线审视报告 |
-
 ### 迭代管理
 
-| 命令 | 说明 |
-|------|------|
-| `prd iteration new` | 开始新迭代 |
-| `prd iteration list` | 列出所有迭代 |
-| `prd iteration current` | 查看当前迭代 |
-
-### 规划管理(B 类)
-
-| 命令 | 说明 |
-|------|------|
-| `prd plan create B1` | 创建需求规划草案 |
-| `prd plan create B2` | 创建规划拆解与范围界定 |
-| `prd plan freeze` | 冻结规划(生成 B3) |
-
-### 版本管理(C 类)
-
-| 命令 | 说明 |
-|------|------|
-| `prd version create C0` | 创建版本范围声明 |
-| `prd version create C1` | 创建版本需求清单 |
-| `prd version freeze` | 冻结版本(生成 C3) |
-
-### 审视管理(R 类)
-
-| 命令 | 说明 |
-|------|------|
-| `prd review r1` | 执行 R1 规划审视 |
-| `prd review r2` | 执行 R2 版本审视 |
-
-### 规则校验 (v1.4.0 新增)
-
-| 命令 | 说明 |
-|------|------|
-| `prd check` | 检查项目是否符合 PRD 规则 |
-| `prd check --json` | 输出 JSON 格式（供 AI 读取） |
-| `prd check --no-log` | 不记录日志 |
-| `prd stats` | 显示规则统计报告 |
-| `prd stats --json` | 输出 JSON 格式统计 |
-
-### 其他命令
-
-| 命令 | 说明 |
-|------|------|
-| `prd ui [file]` | 启动 A2UI 界面预览服务 |
-| `prd upgrade` | 更新项目中的 workflows 和 AI 规则 |
-| `prd index` | 生成/更新迭代索引 |
-
-## 🤖 与 AI IDE 集成
-
-本工具专门设计用于与 AI 编程助手配合使用。
-
-### Cursor / Windsurf / Codeium
-
-工具会自动在项目中创建 `.agent/workflows/` 目录,包含可被 AI 调用的工作流文件。
-
-在 AI 对话中使用:
-
-```
-// 执行 R1 审视
-/prd-r1-review
-
-// 执行 R2 审视
-/prd-r2-review
+```bash
+prd iteration new          # 新建迭代
+prd iteration list         # 列出所有迭代
 ```
 
-### AI 指令示例
+### 规划管理
 
-**R1 规划审视**:
-```
-请按照 .agent/workflows/prd-r1-review.md 中的指令，
-对当前的 B1、B2 文档执行 R1 规划审视。
-```
-
-**R2 版本审视**:
-```
-请按照 .agent/workflows/prd-r2-review.md 中的指令，
-检查 C0、C1 是否忠实执行了 B3 的规划。
+```bash
+prd plan create            # 创建需求规划
+prd plan freeze            # 冻结规划（含自动审视）
+prd plan freeze --force    # 强制冻结（跳过审视）
 ```
 
-### 使用 ChatGPT / Claude / Kimi 等在线 AI
-
-如果你使用的不是 IDE 内置的 AI，可以复制以下提示词到对话开始处：
-
-<details>
-<summary>📋 点击展开完整提示词</summary>
+### IT 管理
 
+```bash
+prd it create "功能名"     # 创建 IT（业务需求+技术规格）
+prd it list                # 列出所有 IT
+prd it show <id>           # 查看 IT 详情
 ```
-你是一个产品需求管理助手，帮助产品经理（PM）按照规范化流程完成需求文档。
-
-# 你的角色
-你是战略思维导师，不是自动化工具或速记员。
-
-# 核心原则
-PM 决策，AI 执行。你的职责是引导、提问、建议，不是替 PM 做决策。
-
-# 工作流程
-产品需求遵循 A → R → B → C 流程：
-- A 类文档：产品基线（A0 产品基础、A1 功能清单、A2 用户反馈）
-- R0：基线审视
-- B 类文档：规划（B1 规划草案、B2 需求拆解、B3 规划冻结）
-- R1：规划审视
-- C 类文档：版本（C0 版本范围、C1 需求清单、C3 版本冻结）
-- R2：版本审视
 
-# 绝对禁止的行为
+### 版本管理
 
-1. ❌ 禁止"快速完成模式"
-   如果 PM 说"帮我快速完成"，你必须拒绝跳过流程。
-
-2. ❌ 禁止未经对话就填充文档
-   创建 B1/B2/C1 后，必须通过对话逐项引导 PM 填写。
-
-3. ❌ 禁止替 PM 做决策
-   优先级（P0/P1/P2）、首版范围、目标定义都由 PM 决定。
-
-4. ❌ 禁止允许跳过必填内容
-   C1 的前 5 个维度（背景/描述/规则/验收/边界）是必填的。
-
-5. ❌ 禁止在 C1 阶段加入新需求
-   C1 阶段发现新需求时，只能暂存到 A2，因为 B3 已冻结。
-
-现在，请告诉我你想从哪个阶段开始，我会引导你完成。
+```bash
+prd version freeze         # 冻结版本（含自动审视）
+prd version freeze --force # 强制冻结（跳过审视）
 ```
 
-</details>
+### 工具命令
 
-**简化版提示词**（适合快速开始）:
-
-```
-你是产品需求管理助手，帮助 PM 按照 A→R→B→C 流程完成需求文档。
-核心规则：PM 决策，AI 执行，不替 PM 做决策，每个阶段都要充分对话。
-请告诉我你想从哪个阶段开始。
+```bash
+prd check                  # 规则校验
+prd stats                  # 统计报告
+prd ui                     # 启动 A2UI 预览
 ```
 
-## 📂 文档结构说明
-
-### A 类 - 现状基线文档
-
-用于建立产品现状的共识,不写规划和愿景。
-
-- **A0**: 产品基础与范围说明
-- **A1**: 已上线功能与流程清单
-- **A2**: 存量反馈与数据汇总
-- **R0**: 基线审视报告
+---
 
-### B 类 - 需求规划文档
+## 🤖 与 AI IDE 集成
 
-定义"要不要做、做什么、做到什么程度"。
+### 支持的 IDE
 
-- **R1**: 规划启动条件检查
-- **B1**: 需求规划草案
-- **B2**: 规划拆解与范围界定
-- **R1**: 规划审视报告(冻结前)
-- **B3**: 规划冻结归档
+- **Cursor** - 自动读取 `.cursorrules`
+- **Antigravity** - 自动读取 `.antigravity/rules.md`
+- **其他 AI IDE** - 读取 `AI-GUIDE.md`
 
-### C 类 - 版本需求文档
+### AI 工作流
 
-将规划转化为可执行的版本需求。
+| 斜杠命令 | 用途 |
+|---------|------|
+| `/prd-代码快照` | AI 扫描代码生成代码快照 |
+| `/prd-需求规划` | 需求规划填写引导 |
+| `/prd-业务需求` | IT 业务需求编写 |
+| `/prd-技术规格` | IT 技术规格编写 |
 
-- **C0**: 版本范围声明
-- **C1**: 版本需求清单
-- **R2**: 版本审视报告(冻结前)
-- **C3**: 版本冻结归档
+### AI 行为规则
 
-## 🔍 典型使用场景
+| ❌ AI 禁止 | ✅ AI 应该 |
+|-----------|-----------|
+| 编造 API/SQL/算法 | 记录技术负责人的确认 |
+| 替 PM 决定优先级 | 引导 PM 自己决策 |
+| 一次性填充文档 | 通过对话逐项完成 |
+| 在业务需求写技术细节 | 保持业务/技术分离 |
 
-### 场景一: 启动新产品
+---
 
-```bash
-prd init new-product
-cd new-product
-prd baseline create A0
-# 填写产品基础信息...
-prd baseline create A1
-# 梳理现有功能...
-prd iteration new
-# 开始第一轮规划...
-```
+## ❓ FAQ
 
-### 场景二: 现有产品新增功能
+### Q: IT 是什么？
 
-```bash
-cd existing-product
-prd iteration new
-# 填写 R1 启动条件检查
-# 确认满足三个条件后...
-prd plan create B1
-# 与 AI 讨论规划草案...
-prd review r1
-# AI 执行审视并通过后...
-prd plan freeze
-```
+**A:** IT = INVEST User Story，是符合 INVEST 原则的用户故事：
 
-### 场景三: 多轮迭代
+- **I**ndependent（独立的）
+- **N**egotiable（可协商的）
+- **V**aluable（有价值的）
+- **E**stimable（可估算的）
+- **S**mall（小的）
+- **T**estable（可测试的）
 
-```bash
-prd iteration list     # 查看历史迭代
-prd iteration current  # 确认当前迭代
-prd iteration new      # 开始新一轮
-```
+### Q: 为什么版本号从 1.5.0 跳到 2.0.0？
 
-## ⚠️ 重要约束
+**A:** 2.0.0 是一个破坏性变更，主要变化：
+- 采用中文命名体系
+- 去除混乱的编号系统（A0/B3/C3/R0...）
+- 简化文件和目录名
 
-### R1 启动条件(三个必须同时满足)
+### Q: 旧项目能升级吗？
 
-1. ✅ 问题真实存在(可在 A 类文档中找到依据)
-2. ✅ 值得单独规划(不是小修小补)
-3. ✅ 问题已理解清楚(边界明确)
+**A:** 可以手动重命名文件，或继续使用旧版本。旧参数（A0/A1/A2）仍然兼容。
 
-### R1 规划审视(五个维度)
+### Q: 审视（R1/R2）去哪了？
 
-1. 目标清晰性
-2. 场景真实性
-3. 现状一致性
-4. 范围收敛性
-5. 版本化准备度
+**A:** 审视作为动作内化到 `freeze` 命令中：
+- `prd plan freeze` 自动执行规划审视
+- `prd version freeze` 自动执行版本审视
 
-### R2 版本审视(五个维度)
+---
 
-1. 版本目标一致性
-2. 版本范围偏移检查
-3. 规划覆盖完整性
-4. 需求粒度成熟度
-5. 进入执行准备度
+## 📚 更多文档
 
-## 🛠️ 开发
+- [GUIDE.md](./GUIDE.md) - 快速使用指南
+- [OVERVIEW.md](./OVERVIEW.md) - 一页式完整总览
+- [CHANGELOG.md](./CHANGELOG.md) - 完整更新日志
 
-```bash
-git clone <repository>
-cd prd-cli
-npm install
-npm link  # 本地测试
-```
+---
 
-## 📄 License
+## 📝 License
 
 MIT
-
-## 🤝 贡献
-
-欢迎提交 Issue 和 Pull Request!
-
-## 📮 反馈
-
-如有问题或建议,请提交 Issue。
-
----
-
-**核心价值**: 让 AI 从"陪你写需求"变成"帮你挡住不该写的需求"

package/bin/prd-cli.js

@@ -42,6 +42,7 @@ program
   .description('管理 B 类规划文档 (create B1|B2, freeze)')
   .option('--pm-confirmed', 'PM 已在对话中确认，跳过交互式确认')
   .option('--pm-signature <name>', 'PM 签名（用于冻结操作）')
+  .option('--force', '强制冻结，跳过前置检查（不推荐）')
   .action((action, type, options) => {
     require('../commands/planning')(action, type, options);
   });
@@ -61,10 +62,19 @@ program
   .description('管理 C 类版本文档 (create C0|C1, freeze)')
   .option('--pm-confirmed', 'PM 已在对话中确认，跳过交互式确认')
   .option('--pm-signature <name>', 'PM 签名（用于冻结操作）')
+  .option('--force', '强制冻结，跳过前置检查（不推荐）')
   .action((action, type, options) => {
     require('../commands/version')(action, type, options);
   });
 
+// IT (INVEST) 命令
+program
+  .command('it <action> [name]')
+  .description('管理 IT 用户故事 (create|list|show)')
+  .action((action, name, options) => {
+    require('../commands/it')(action, name, options);
+  });
+
 // 需求变更命令
 program
   .command('change')
@@ -135,22 +145,19 @@ program
 // 帮助信息增强
 program.on('--help', () => {
   console.log('');
-  console.log(chalk.bold('典型工作流:'));
+  console.log(chalk.bold('简化工作流（6 步）:'));
   console.log('  1. ' + chalk.cyan('prd init <项目名>') + '          # 初始化项目');
-  console.log('  2. ' + chalk.cyan('prd baseline create A0') + '      # 创建产品基础文档');
-  console.log('  3. ' + chalk.cyan('prd iteration new') + '           # 开始新迭代');
-  console.log('  4. ' + chalk.cyan('prd plan create B1') + '          # 创建规划草案');
-  console.log('  5. ' + chalk.cyan('prd review r1') + '               # R1 审视');
-  console.log('  6. ' + chalk.cyan('prd plan freeze') + '             # 冻结规划(B3)');
-  console.log('  7. ' + chalk.cyan('prd version create C0') + '       # 创建版本范围');
-  console.log('  8. ' + chalk.cyan('prd review r2') + '               # R2 审视');
-  console.log('  9. ' + chalk.cyan('prd version freeze') + '          # 冻结版本(C3)');
+  console.log('  2. ' + chalk.cyan('prd plan create B1') + '          # 创建规划草案');
+  console.log('  3. ' + chalk.cyan('prd plan create B2') + '          # 创建规划拆解');
+  console.log('  4. ' + chalk.cyan('prd plan freeze') + '             # 冻结规划（自动 R1 审视）');
+  console.log('  5. ' + chalk.cyan('prd version create C1') + '       # 创建版本需求（含版本范围）');
+  console.log('  6. ' + chalk.cyan('prd version freeze') + '          # 冻结版本（自动 R2 审视）');
   console.log('');
   console.log(chalk.bold('文档说明:'));
-  console.log('  A 类 - 现状基线文档 (A0, A1, A2, R0)');
+  console.log('  A 类 - 现状基线文档 (A0, A1, A2)');
   console.log('  B 类 - 需求规划文档 (B1, B2, B3)');
-  console.log('  C 类 - 版本需求文档 (C0, C1, C3)');
-  console.log('  R 类 - 审视报告 (R1, R2)');
+  console.log('  C 类 - 版本需求文档 (C1 已含版本范围, C3)');
+  console.log('  R 类 - 审视（已集成到 freeze 命令）');
   console.log('');
   console.log(chalk.bold('维护命令:'));
   console.log('  ' + chalk.cyan('prd upgrade') + '                 # 更新 workflows 和 AI 规则到最新版本');