Skip to content

2. 核心需求

需求列表

需求 ID优先级需求描述状态验收标准
R-001P0搭建 VitePress 基础站点已完成可正常启动和构建
R-002P0建立 PRD 标准目录结构已完成11 项要素模板齐全
R-003P0实现版本切换功能已完成Navbar 下拉可切换版本
R-004P1自定义 PRD 主题组件已完成PrdMeta、StatusBadge 可用
R-005P1Mermaid 流程图支持已完成流程图正常渲染
R-006P1CLI 脚本工具已完成new-version、new-feature 可用
R-007P2动态 Sidebar 生成已完成根据版本目录自动渲染
R-008P24 阶段 AI Prompt已完成4 个 Prompt 模板齐全

P0 需求(必须有)

R-001:搭建 VitePress 基础站点

需求描述: 初始化 VitePress 项目,配置基础站点信息、主题、搜索等功能。

验收标准:

  • [x] npm run docs:dev 可正常启动开发服务器
  • [x] npm run docs:build 可正常构建静态站点
  • [x] 站点标题、描述等基础信息配置正确
  • [x] 本地搜索功能可用

R-002:建立 PRD 标准目录结构

需求描述: 设计并建立 PRD 的标准目录结构,每份 PRD 包含 11 项标准要素。

验收标准:

  • [x] 目录结构清晰,层次分明
  • [x] 11 项要素均有对应的模板文件
  • [x] 文件命名规范统一
  • [x] Frontmatter 格式标准化

R-003:实现版本切换功能

需求描述: 实现多版本 PRD 的切换功能,用户可以在不同版本间快速跳转。

验收标准:

  • [x] Navbar 有版本下拉选择器
  • [x] 可切换不同版本的 PRD
  • [x] 切换后 Sidebar 同步更新
  • [x] 版本列表集中配置管理

P1 需求(应该有)

R-004:自定义 PRD 主题组件

需求描述: 开发 PRD 专用 Vue 组件,提升文档可读性和专业感。

验收标准:

  • [x] PrdMeta 组件可展示版本元信息
  • [x] StatusBadge 组件可展示需求状态
  • [x] 组件样式适配明暗主题
  • [x] 组件在 Markdown 中可直接使用

R-005:Mermaid 流程图支持

需求描述: 集成 Mermaid 插件,支持在 PRD 中绘制流程图、时序图、ER 图等。

验收标准:

  • [x] Mermaid 语法可正常渲染
  • [x] 流程图、时序图、ER 图均支持
  • [x] 暗色模式下图表样式自适应
  • [x] 图表在构建后的站点中正常显示

R-006:CLI 脚本工具

需求描述: 提供 CLI 工具脚本,简化版本和功能模块的创建。

验收标准:

  • [x] new-version.js 可创建完整版本目录和模板
  • [x] new-feature.js 可在指定版本下创建功能模块
  • [x] 脚本自动更新版本配置
  • [x] 有清晰的错误提示和使用说明

P2 需求(可以有)

R-007:动态 Sidebar 生成

需求描述: 根据版本目录结构动态生成 Sidebar,无需手动配置。

验收标准:

  • [x] 根据 /versions/vX.Y.Z/ 路径自动渲染 Sidebar
  • [x] 章节顺序固定(01-11)
  • [x] 功能模块自动展开子目录
  • [x] 模板、规范、AI Prompts 页面也有 Sidebar

R-008:4 阶段 AI Prompt

需求描述: 编写 4 阶段 AI 工作流的 Prompt 模板,规范 AI 协作流程。

验收标准:

  • [x] 角色设定 Prompt 完整
  • [x] 需求讨论 Prompt 含追问逻辑
  • [x] PRD 生成 Prompt 含文件结构约束
  • [x] 审校 Prompt 含检查清单
  • [x] 用户文档 Prompt 含输出格式