Skills
skills/guoxiangjie/skills/prd-suite

prd-suite

SKILL.md

PRD 文档管理

🆕 自然语言需求模板支持

支持使用自然语言需求模板快速创建PRD：

  1. 需求模板文件：提供 requirement_template.md 文件，用自然语言描述项目需求
  2. 智能提取：AI自动从自然语言中提取结构化信息
  3. 四种模式：
    • 使用 XMind 文件：通过 XMind MCP 读取 xmind 文件生成 PRD（推荐，需要 XMind MCP）
    • 使用需求文件：直接根据需求文件生成完整 PRD（1 轮完成）
    • 混合模式：需求文件 + 交互补充缺失章节
    • 手动创建：使用交互式流程逐轮收集信息（9 轮）

详细模板见：templates/requirement_template.md

目录结构

prd-suite/
├── SKILL.md          # 主入口
├── commands/         # 子命令
│   ├── create.md     # 创建PRD命令
│   ├── update.md     # 更新PRD命令
│   └── delete.md     # 删除PRD命令
├── templates/        # 模板文件
│   ├── main_prd_template.md    # 主PRD模板
│   ├── module_prd_template.md  # 模块PRD模板
│   └── requirement_template.md # 需求模板
├── config/           # 配置文件
│   └── config.json   # 配置信息
└── scripts/          # 辅助脚本
    ├── parser.js     # 自然语言解析脚本
    └── utils.js      # 工具函数

子命令

create

  • 功能：创建新的 PRD 文档
  • 子命令：
    • create main - 创建主PRD文档
    • create module - 创建模块PRD文档
  • 描述：支持自然语言需求模板快速生成，智能推断减少重复输入
  • 路径：commands/create.md

update

  • 功能：更新现有的 PRD 文档
  • 子命令：
    • update main - 更新主PRD文档
    • update module - 更新模块PRD文档
  • 描述：支持单章节更新，版本管理和变更记录
  • 路径：commands/update.md

delete

  • 功能：删除 PRD 文档
  • 子命令：
    • delete module - 删除模块PRD文档
  • 描述：安全删除模块PRD，自动更新索引和变更日志
  • 路径：commands/delete.md

配置文件

配置文件位于 config/config.json，包含以下内容：

  • 技能基本信息
  • 子命令配置
  • 模板文件路径
  • 变量定义
  • 功能特性开关

模板文件

模板文件位于 templates/ 目录：

  • main_prd_template.md - 主PRD文档模板
  • module_prd_template.md - 模块PRD文档模板
  • requirement_template.md - 自然语言需求模板
  • changelog_format.md - CHANGELOG 格式规范

辅助脚本

辅助脚本位于 scripts/ 目录：

  • parser.js - 自然语言需求解析脚本
  • utils.js - 工具函数（日期处理、文件操作等）

📋 模板格式要求

⚠️ 重要说明

所有生成的 PRD 文档必须严格遵循模板格式！ 这是确保 PRD 质量和一致性的关键要求。

模板文件

模板文件位于 templates/ 目录，必须严格按照以下模板生成内容：

  1. 主 PRD 模板：templates/main_prd_template.md
    • 用于创建主 PRD 文档
    • 包含 9 个标准章节
    • 必须保持章节顺序、表格格式、Mermaid 图表格式
  2. 模块 PRD 模板：templates/module_prd_template.md
    • 用于创建模块 PRD 文档
    • 包含 11 个标准章节
    • 必须保持章节顺序、表格格式、Mermaid 图表格式

格式要求

在生成 PRD 时，必须：

  1. 严格遵循模板结构
    • 保持所有章节的顺序和编号
    • 不遗漏任何必需章节
    • 不添加模板中未定义的章节
  2. 保持格式一致性
    • 表格格式必须与模板一致
    • Mermaid 图表语法必须正确
    • 标题层级必须正确
  3. 完整替换变量
    • 所有 {{变量名}} 必须替换为实际内容
    • 不保留任何未替换的变量占位符
  4. 格式验证
    • 生成后必须检查格式是否符合模板
    • 发现格式问题必须立即修正

格式规范说明

详细的格式规范请参考：templates/format_guidelines.md

核心特性

1. 自然语言需求模板

  • 支持用自然语言描述项目需求
  • AI自动提取结构化信息
  • 1轮完成PRD生成

2. 智能推断机制

  • 从主PRD自动提取相关信息
  • 减少用户重复输入
  • 提升创建效率

3. 快速模式

  • 只生成核心章节
  • 跳过可选章节
  • 适合次要模块

4. 版本管理

  • 支持语义化版本
  • 自动记录变更日志
  • 版本升级流程

🗺️ XMind 文件支持

功能说明

支持从 XMind 思维导图文件直接生成主 PRD：

  1. XMind MCP 集成：通过 XMind MCP 服务读取和解析 xmind 文件
  2. 智能内容提取：从思维导图结构中提取 PRD 所需信息
  3. 中间文档生成：生成 xmind_content.md 内容文档供确认
  4. 模板格式输出：按照主 PRD 模板格式生成最终文档

使用条件

  • XMind MCP 服务必须可用
  • 当前工作目录下存在 .xmind 文件

支持的 XMind MCP 工具

  • mcp_XMind_list_xmind_directory：扫描目录下的 xmind 文件
  • mcp_XMind_read_xmind：读取和解析 xmind 文件
  • mcp_XMind_extract_node：提取特定节点
  • mcp_XMind_search_nodes：搜索节点内容

流程说明

详细流程请参考：commands/create.md 中的"使用 XMind 文件创建主 PRD 详细流程"

工作流程

创建主PRD流程

  1. 检测 XMind MCP：检测 XMind MCP 服务是否可用
  2. 检测需求模板：检查是否存在 requirement_template.md
  3. 选择模式：使用 XMind 文件、使用需求文件、混合模式或手动创建
  4. 信息收集：根据模式收集必要信息
  5. 生成文档：生成完整PRD文档内容（⚠️ 不创建文件）
  6. 展示内容：展示完整内容供用户查看
  7. 暂停等待审核：⚠️ 必须暂停，等待用户审核确认
  8. 审核确认：用户审核生成的内容
  9. 完成创建：审核通过后创建PRD文件并更新相关索引

创建模块PRD流程

  1. 前置条件：检查主PRD是否存在
  2. 选择模块：从主PRD的模块清单中选择要创建的模块
  3. 模式选择：
    • 快速模式：根据主PRD和模块信息自动生成完整内容，然后审核确认
    • 问答模式：逐章节询问核心业务信息，提供参考信息，生成章节内容，章节审核，直至完成
  4. 内容生成：根据选择的模式生成模块PRD内容
  5. 审核确认：用户审核生成的内容
  6. 完成创建：创建模块PRD文件并更新相关索引

更新PRD流程

  1. 选择文档：选择要更新的PRD
  2. 选择章节：选择要更新的章节
  3. 信息收集：收集更新信息
  4. 生成内容：生成更新后的章节内容（⚠️ 不更新文件）
  5. 展示内容：展示更新内容供用户查看
  6. 暂停等待审核：⚠️ 必须暂停，等待用户审核确认
  7. 审核确认：用户审核生成的内容
  8. 版本管理：处理版本升级
  9. 完成更新：审核通过后更新PRD文件和相关记录

删除PRD流程

  1. 选择模块：选择要删除的模块PRD
  2. 安全确认：确认删除操作
  3. 删除文件：删除模块PRD文件
  4. 更新索引：更新 PRD_INDEX.md
  5. 更新变更日志：记录删除操作
  6. 确认完成：向用户确认删除完成

📝 CHANGELOG 记录规范

核心原则

CHANGELOG 本身没有版本概念，它只是一个变更记录文件。

  • CHANGELOG 按日期记录变更
  • 每条变更记录关联到具体的 PRD 文件及其版本
  • PRD 文件有自己的版本号（如 v1.0、v1.1）

记录格式

更新 PRD 时，必须在 CHANGELOG.md 中记录变更前后对比：

## 2024-01-15

### 📄 电商平台_main_prd.md (v1.0 → v1.1)

**变更概述**：调整用户管理模块的功能需求

#### 第3章 功能模块清单

| 变更项 | 变更前 | 变更后 | 变更原因 |
|--------|--------|--------|----------|
| 用户登录方式 | 仅支持账号密码登录 | 新增微信、支付宝第三方登录 | 用户反馈登录方式单一 |

详细规范

完整的 CHANGELOG 格式规范请参考：templates/changelog_format.md

⚠️ 审核确认机制

所有 PRD 创建和更新操作都必须经过用户审核确认！

审核流程

  1. 生成内容：AI 生成 PRD 内容（⚠️ 不创建或更新文件）
  2. 展示内容：展示完整内容供用户查看
  3. 暂停等待：⚠️ 必须暂停，等待用户审核
  4. 用户选择：
    • ✅ 确认通过：继续执行后续操作
    • ✏️ 提出修改意见：用户输入修改意见，AI 修改后再次展示审核
    • 🔄 重新生成：重新生成内容，再次展示审核
    • ❌ 取消操作：终止流程，不创建或更新文件
  5. 执行后续：审核通过后才执行后续操作（创建文件、更新索引等）

重要原则

  • 先审核后执行：审核通过前不得创建或更新文件
  • 必须暂停等待：AI 不得自动跳过审核步骤
  • 支持迭代修改：用户可多次提出修改意见
  • 提供完整选项：必须提供确认、修改、重新生成、取消四个选项

审核选项说明

  1. ✅ 确认通过
    • 用户确认内容无误
    • 继续执行后续操作（创建文件、更新索引等）
  2. ✏️ 提出修改意见
    • 用户输入具体的修改意见
    • AI 根据意见修改内容
    • 修改后再次展示，进入新一轮审核
  3. 🔄 重新生成
    • 用户对整体内容不满意
    • AI 重新生成内容
    • 重新生成后再次展示审核
  4. ❌ 取消操作
    • 用户取消本次操作
    • 不创建或更新任何文件
    • 终止流程

详细审核流程说明请参考：templates/review_process.md

使用方法

创建主PRD

  1. 准备 requirement_template.md 文件（可选）
  2. 调用 prd-suite skill
  3. 选择 create main 命令
  4. 选择创建模式
  5. 审核生成的内容
  6. 完成创建

创建模块PRD

  1. 确保主PRD已存在
  2. 调用 prd-suite skill
  3. 选择 create module 命令
  4. 选择完整模式或快速模式
  5. 审核生成的内容
  6. 完成创建

更新PRD

  1. 调用 prd-suite skill
  2. 选择 update 命令
  3. 选择要更新的PRD和章节
  4. 提供更新信息
  5. 审核生成的内容
  6. 处理版本管理
  7. 完成更新

删除模块PRD

  1. 调用 prd-suite skill
  2. 选择 delete module 命令
  3. 选择要删除的模块
  4. 确认删除
  5. 完成删除

注意事项

  • 支持自然语言需求模板快速生成
  • 保持向后兼容
  • 所有变更都会记录到 CHANGELOG.md
  • 模块PRD会自动更新到 PRD_INDEX.md
  • 支持版本管理和状态管理
Weekly Installs
10
Repository
guoxiangjie/skills
First Seen
5 days ago
Security Audits
Gen Agent Trust HubPass
SocketPass
SnykPass
Installed on
claude-code10
github-copilot10
codex10
kimi-cli10
amp10
cline10