Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PRD 工具包(prd-kit)

用于 PRD 驱动实现:在 Cursor 中通过项目规则 + PRD 文档拉齐范围;在其它 IDE 中通过 ide/rule.md + 同一份 PRD 工作。

本目录可整包复制为新 Git 仓库根,或只复制其中一部分到业务项目(不强制在这里执行 git init,由你自行发布到 GitHub 等)。

核心特性

  • 四阶段流程:设计 → 规划 → 实现 → 测试,每个阶段有明确的准入准出标准
  • 专业角色引导:产品经理、架构师、开发工程师、QA,各阶段由对应角色主导
  • 轻量可扩展:支持文档模式和聊天模式,适应不同项目规模

内容结构

路径 说明
config/PROJECT.md 项目模板:PRD 根路径、验证命令、主栈、补充链接。复制到业务项目根config/PROJECT.md 并按项目填写。
.cursor/rules/ 核心规则(5 个阶段规则),复制到业务项目的 .cursor/rules/
.cursor/skills/product-manager/ 产品经理 Skill:深度产品分析能力,按需调用。
docs/design/_templates/ 设计文档模板(主文档 + 版本文档)。
templates/prd/feature-template.md PRD 文档模板,可放入 docs/prd/templates/
examples/godot-csharp/ 可选的 Godot 4 + C# 架构与命名规范示例;在需要时与核心规则一起复制。

四阶段工作流程

┌─────────────┐    ┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│  1. 设计阶段  │ → │  2. 规划阶段  │ → │  3. 实现阶段  │ → │  4. 测试阶段  │
│  10-design  │    │ 15-planning │    │ 20-impl     │    │ 30-testing  │
│   产品经理   │    │   架构师    │    │  开发工程师  │    │    QA      │
└─────────────┘    └─────────────┘    └─────────────┘    └─────────────┘
   设计/PRD          实施计划            代码产出           测试通过

各阶段角色与产出

阶段 规则文件 角色 核心产出 触发条件
设计 10-design.mdc 产品经理 Lisa 设计文档 + PRD docs/design/**/*.md
规划 15-planning.mdc 架构师 Alex 实施计划(任务拆解 + 依赖排序) docs/prd/active/**/*.md
实现 20-implementation.mdc 开发工程师 David 代码 + 单元测试 代码文件, alwaysApply
测试 30-testing.mdc QA Emma 测试报告 **/*.test.*, tests/**

主流程规则

00-workflow.mdc:定义四阶段模型的准入准出标准:

  • 设计 → 规划:PRD 状态为 active
  • 规划 → 实现:实施计划 plan: ready
  • 实现 → 测试:代码完成 impl: done

在 Cursor 中安装

  1. .cursor/rules/ 下所有 .mdc 复制到目标仓库的 .cursor/rules/
  2. .cursor/skills/product-manager/ 复制到目标仓库的 .cursor/skills/(可选,用于深度产品分析)。
  3. config/PROJECT.md 复制到目标仓库根下 config/PROJECT.md(与模板合并或照抄后修改)。
  4. 在业务仓库中按模板维护 PRD,默认约定 docs/prd/active/*.md(可改,但需同步改规则中的 globsconfig/PROJECT.md)。
  5. 若需 Godot C# 分层/命名,见 examples/godot-csharp/README.md,将其中的 mdc 一并复制到 .cursor/rules/

使用示例

创建新项目

用户:我想做一个在线商城

Lisa(产品经理,10-design):
"我是产品经理 Lisa,建议我们先明确目标用户群体..."

→ 产出:docs/design/shopping-mall/README.md
→ 产出:docs/prd/active/user-system.md

规划实施

用户:PRD 已确认,开始规划

Alex(架构师,15-planning):
"我是架构师 Alex,建议分三个阶段实施..."

→ 产出:docs/plan/user-system-plan.md(可选)
→ 或对话确认实施计划

编码实现

用户:按计划实现 Phase 1

David(开发工程师,20-implementation):
"我是 David,按 Phase 1 计划开始编码..."

→ 产出:代码 + 单元测试
→ 产出:完成报告

深度产品分析(Skill)

用户:用产品经理视角深度分析这个需求

→ 触发 Skill:完整的需求分析、竞品对比、风险评估

在非 Cursor 的 IDE 中

  • ide/rule.md 加入项目,或在对话中粘贴其中「实现步骤/不确定时/完成报告」段落。
  • 与具体 docs/prd/.../功能.mdconfig/PROJECT.md 一起交给助手。

与业务仓库的两种关系

  • 仅本工具包独立发布:游戏/应用项目可保持自有 .cursor/rules 不变,只把本 prd-kit 作为对外分发
  • 以工具包为真源:业务仓库中的规则可由本包定期同步,避免两套漂移(团队自行约定流程)。

安全

不要在本工具包内提交真实密钥。业务侧遵循各项目 .env.example 与内控要求。

About

通用PRD来规范AI实现功能

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors