产品需求文档

主题

12. 使用说明书 ​

简介 ​

VitePress PRD 脚手架是一个基于 VitePress 的产品需求文档管理工具。它帮助产品经理标准化 PRD 撰写流程，通过版本管理追溯需求演进，借助 AI 管线化工作流提升文档产出效率。

使用前提 ​

  • 已安装 Node.js（版本 18 或以上）
  • 已克隆或下载本仓库到本地
  • 已执行 npm install 安装依赖

操作步骤 ​

启动文档站点 ​

  1. 进入项目目录：打开终端，切换到项目根目录
  2. 安装依赖（首次使用）：执行 npm install
  3. 启动开发服务器：执行 npm run docs:dev
  4. 在浏览器中打开：根据终端提示的地址（通常是 http://localhost:5173）访问站点

创建新版本 PRD ​

  1. 运行创建命令：在终端执行 npm run new-version v1.1.0
  2. 查看生成的文件：在 docs/versions/v1.1.0/ 目录下可以看到完整的 PRD 模板结构
  3. 编辑版本首页：打开 docs/versions/v1.1.0/index.md，填写版本号、状态、日期、作者、迭代目标等元信息
  4. 编辑各章节内容：按顺序填充 01-background 到 11-risk 的内容

添加功能模块 ​

  1. 运行创建命令：执行 npm run new-feature v1.1.0 F-001 "功能名称"
  2. 查看生成的文件：在 docs/versions/v1.1.0/05-features/ 目录下会生成新的功能模块文件
  3. 编辑功能详情：完善功能概述、用户故事、前置条件、功能详述、验收标准等内容

使用 AI 协作工作流 ​

  1. 需求讨论：向 AI 描述你的产品想法，AI 会帮你梳理结构化的需求要点
  2. PRD 生成：将确认的需求要点提供给 AI，AI 按模板生成完整的 PRD 各章节
  3. PRD 审校：让 AI 检查 PRD 的完整性、一致性和可行性
  4. 用户文档生成：基于确认的 PRD，让 AI 生成面向终端用户的操作说明

构建和部署 ​

  1. 构建静态站点：执行 npm run docs:build
  2. 查看构建结果：构建后的文件在 docs/.vitepress/dist/ 目录
  3. 预览构建结果：执行 npm run docs:preview

常见问题 ​

Q1：版本号怎么定？ ​

A：采用语义化版本号格式 vX.Y.Z：

  • X（主版本）：重大功能变更或架构调整
  • Y（次版本）：新功能迭代
  • Z（修订号）：Bug 修复或小型优化

Q2：AI 生成的 PRD 可以直接用吗？ ​

A：AI 生成的 PRD 是初稿，必须经过人工审校和确认。特别是验收标准、数据模型、接口定义等技术细节，需要与研发团队确认后再定稿。

Q3：原型截图放在哪里？ ​

A：将设计稿截图放入对应版本的 07-prototype/ 目录，并在 07-prototype/README.md 中登记素材索引。

Q4：如何归档旧版本？ ​

A：旧版本保留在 versions/ 目录下即可，Navbar 版本选择器会自动列出所有版本。如需归档，可以移动到单独的 archive/ 目录。