@herenit/prd-helper
v0.2.4
Published
**HerenDesign 需求助手** 是一套为需求工作设计的 AI 协作规范与工具集。
Readme
HerenDesign 需求助手
HerenDesign 需求助手 是一套为需求工作设计的 AI 协作规范与工具集。
它告诉 AI 如何理解你的需求、如何写 PRD、如何做原型、如何建 TAPD 单子。
你只需要像平常一样跟 AI 对话说需求,AI 背后会自动遵循 HerenDesign 需求助手的规则,把需求文档、交互原型、TAPD 建单全部搞定,并持续修改到你满意为止。
整个过程不需要你写代码、不需要你懂技术,只需要像聊天一样跟 AI 说需求就行。
说需求 -> AI 按照 HerenDesign 需求助手的规范帮你写文档和做页面 -> 现场确认 -> 反复修改,直到满意为止。
graph LR
A["说需求"] --> B["AI 按照规范写文档和做页面"]
B --> C["现场确认"]
C --> D{"是否满意"}
D -- "否" --> A
D -- "是" --> E["完成"]
E --> F["对接 TAPD"]推荐使用场景
- 产品经理:快速产出 PRD 和可交互原型,用于需求沟通和确认。
- 交付人员:在现场快速响应项目方需求变化,高效完成需求确认和文档沉淀。
使用流程
整个流程简单到只有 3 步,全程像聊天一样对话完成。
前置条件:你需要在 Codex、Claude Code、Workbuddy 等 AI 中打开文件目录,并在对话中描述你的需求。HerenDesign 需求助手会在后台指导 AI 如何响应你的需求。
第 1 步:准备工作,只需做一次
找一台电脑,确保已经安装了 Node.js。推荐使用 Node.js v22 版本,最低要求为 Node.js 20。
然后对 AI 说一句话:
“帮我使用
npm install -g @herenit/prd-helper命令安装 HerenDesign 需求助手”
AI 会自动帮你完成安装。如果你习惯手动操作,也可以复制下面这行命令交给 AI 执行,或者自己在终端里粘贴运行:
npm install -g @herenit/prd-helper如果你连终端是什么都不知道,也没关系。直接把上面那句话复制给 AI,它会一步步带你完成。
安装完成后,可以让 AI 执行下面的命令确认工具可用:
hrdp更新 HerenDesign 需求助手
你可以直接复制下面这段话发给 AI,让 AI 帮你检查并完成更新:
“请在当前需求工作区执行
hrdp check-update --json检查 HerenDesign 需求助手是否有新版本。如果有新版本,请先告诉我当前工作区模板版本、当前 hrdp 版本、最新版本、准备执行的安装命令,以及hrdp update会更新哪些内容;等我确认后,再执行npm install -g @herenit/prd-helper安装新版 CLI,并在当前工作区执行hrdp update完成工作区更新。”
如果你习惯自己操作,也可以按下面的命令手动执行。先在已有需求工作区里检查是否有新版本:
hrdp check-update --json检测到有新版本后,先重新安装全局 CLI:
npm install -g @herenit/prd-helper然后进入已有需求工作区,执行工作区更新:
hrdp update注意:重新安装只会更新电脑上的
hrdp命令;hrdp update才会把已有工作区里的规则、skills 和离线资源刷新到当前 CLI 版本。
如果只是后续新建需求工作区,完成全局 CLI 更新后,直接在新的空文件夹里执行 hrdp init 即可使用最新模板。
手动兜底更新
如果 hrdp update 不可用,或者工作区文件被人工改到无法自动更新,可以按下面的方式手动兜底刷新:
- 先备份原工作区里的
requirements/目录,这是已经产出的需求文档、原型和需求创建材料。 - 如果已经配置过 TAPD 授权,也要备份
.agents/skills/tapd-ops/config.json、.claude/skills/tapd-ops/config.json、.workbuddy/skills/tapd-ops/config.json等本地配置文件;这些文件可能包含个人访问令牌,不要发给他人。 - 确认备份可用后,清空原工作区中的文件和目录。
- 在原工作区重新执行
hrdp init,生成最新的AGENTS.md、CLAUDE.md、skills 和vendor/。 - 把备份的
requirements/目录还原回原工作区。 - 如需继续使用原 TAPD 授权,把备份的
tapd-ops/config.json还原到对应平台的 skills 目录。
如果原工作区里曾经手动改过 AGENTS.md、CLAUDE.md 或某个 skill 文件,不建议直接覆盖;请先备份完整工作区,再把自定义内容合并回新模板。
第 2 步:创建工作区
直接告诉 AI:新建一个文件夹,比如叫“某某项目需求工作区”,然后让它帮你:
“帮我在当前文件夹,使用
hrdp init命令初始化 HerenDesign 需求助手”
AI 会自动帮你把文件夹变成标准的工作区结构,里面已经包含了后续工作所需的全部配置。你不需要关心它具体做了什么,只需要知道:可以开始干活了。
如果你习惯自己执行命令,也可以在一个空文件夹里运行:
hrdp init初始化后的工作区大致如下:
.
├── AGENTS.md
├── CLAUDE.md
├── .gitignore
├── requirements/
├── exports/ 导出后生成
├── .agents/skills/ GitHub Copilot、Cursor、ZCode、OpenCode、Codex 共用的主分发目录
├── .claude/skills/ Claude Code 的官方 Skill 副本
├── .workbuddy/skills/ WorkBuddy 的官方 Skill 副本
└── vendor/AGENTS.md/CLAUDE.md:告诉 AI 怎么按 HerenDesign 需求助手的规则工作。requirements/:存放每个需求的 PRD、原型和需求创建材料。exports/:执行hrdp export <需求名称>后生成,存放可上传到需求平台的 ZIP 附件包。.agents/skills/、.claude/skills/、.workbuddy/skills/:存放 CLI 官方 Skill;.agents/skills/是唯一主分发目录,平台副本由 CLI 自动同步。vendor/:存放原型离线打开所需的前端资源。
确认当前是否在工作区
开始整理需求前,最好先确认 AI 打开的文件夹是不是刚才初始化出来的工作区。你可以直接把下面这句话发给 AI:
“请执行
hrdp doctor --json,帮我确认当前是不是 HerenDesign 需求助手工作区。”
如果你习惯自己操作,也可以在终端里运行:
hrdp doctor执行后看结论即可:
- 如果显示 “在工作区”,就可以继续和 AI 说需求。
- 如果显示 “不在工作区”,但下面列出了
cd ... && hrdp doctor,复制其中一条执行,就能切到候选工作区再确认一次。 - 如果没有候选工作区,说明当前文件夹可能还没有初始化;请先切到正确文件夹,或在空文件夹里执行
hrdp init。
这个命令只做检查,不会修改你的文件。给 AI 或脚本使用时,建议执行结构化输出:
hrdp doctor --json脚本判断时可以使用退出码:0 表示当前在工作区,1 表示当前不在工作区。
第 3 步:开始干活
前提:当前 AI 对话必须在 HerenDesign 需求助手创建的工作区中打开。
直接告诉 AI 你想整理什么需求。比如:
“帮我整理一个床护套餐批量记账需求。”
AI 会自动按照 HerenDesign 需求助手的规范完成以下事情:
- 问清楚需求细节,如果还不清楚的话。
- 创建好独立的需求文件夹。
- 写出一份结构清晰的 PRD 文档。
- 生成可以直接打开的交互原型页面。
生成的 HTML 原型双击就能打开,不需要联网,不需要启动任何服务。随时可以拿给项目方看、点一点、确认流程对不对。
如果项目方说“这里要改一下”,你就直接告诉 AI,比如:
“在页面底部增加打印和导出按钮。”
AI 会自动同步更新 PRD 和原型,保证两份产物始终一致。
最终产物
每个需求都会得到一份独立的产物:
需求名称/
├── 需求名称PRD.md 文档,写清楚背景、功能、规则、验收标准
└── 需求名称原型.html 页面,可交互,双击打开就能看- PRD:交给研发看的业务依据,清清楚楚。
- 原型:给项目方看的页面样子,点一点就能体验流程,确认无误。
对接 TAPD
当 PRD 和原型都确认好了,需要正式录入 TAPD 项目管理系统时,直接告诉 AI:
“帮我把这个需求创建到 TAPD。”
AI 会按照 HerenDesign 需求助手的规范自动完成:
- 打包产物:把 PRD 文档和 HTML 原型打包成一个 ZIP 文件。
- 自动建单:在 TAPD 系统中创建一个新的需求单。
- 上传附件:把 ZIP 包作为附件挂在需求单上。
TAPD 授权
第一次用的时候,需要先授权 TAPD 账号。你只需要对 AI 说:
“填写 TAPD 授权。”
AI 会引导你完成授权流程,之后就不用再重复操作了。
操作 TAPD
你可以直接告诉 AI:
“帮我把处理人设为张三,预计开始时间设在下周一,预计结束时间设在下周五。”
AI 会自动填好这些关键字段。其他自定义核心字段,建议创建完成后打开 TAPD 平台手动补充完善。
更多说明
- 完整使用指南见 docs/使用指南.md。
- CLI 命令名为
hrdp,包名为@herenit/prd-helper。
