edit | blame | history | raw

pro-doc 目录导读

创建人员:Codex
文件职责:说明 common/pro-doc 目录下产品体系规范、创建指南、模板和需求写作规范的用途。
管理规范/模板:../../全局规范.md;../../体系说明.md;产品规范.md。
引用文件:产品规范.md;产品环境创建指南.md;产品审核规范.md;需求规范.md;本目录下全部 *模版.md*范本.md 文件。
记录方式:目录入口文档;新增或删除本目录正式文档时同步更新。

1. 目录定位

本目录保存通用产品体系文档。

产品体系负责管理产品、需求、策略、业务规则、方法论转需求等事项。它回答:

  1. 产品事项为什么出现。
  2. 产品目标和边界是什么。
  3. 产品方案或需求怎么设计。
  4. 设计是否经过审核。
  5. 产品产物是否能交给开发、实验、案例分析或项目管理继续消费。
  6. 非审计来源产品问题如何闭环。

产品体系不写代码,不跑实验,不替代案例分析。需要代码时进入开发体系的产品开发工作区;需要验证时进入实验体系;需要逐案分析时进入案例分析体系。

2. 文件清单

文件 类型 作用
产品规范.md 全局产品规范 说明产品体系定位、流程、文档职责、边界和问题闭环
产品环境创建指南.md 创建指南 指导项目管理员在具体项目中创建产品体系
产品审核规范.md 审核规范 定义产品设计审核、产品产物审核、需求清晰度审核和闭环规则
需求规范.md 写作规范 约束需求文档写法、需求审核流程和进入编码阶段的条件
产品总纲模版.md 模板 创建项目内 产品总纲.md,记录产品事项背景、目标、状态和结论
产品设计模版.md 模板 创建项目内 产品设计.md,记录产品方案、需求拆解、输入输出和验收方式
产品方案文档范本.md 范本 大量产品修改时参考,先讲清修改背景、内容、影响和验收
产品架构文档范本.md 范本 第一版复杂产品交付时参考,说明整体结构和模块关系
产品模块说明文档范本.md 范本 第一版复杂产品交付时参考,说明模块功能、作用、边界和上下游
产品核心流程文档范本.md 范本 第一版复杂产品交付时参考,说明主流程、分支和交付链路
产品执行日志模版.md 模板 创建项目内 产品执行日志.md,记录产品事项执行、产物路径、偏离和自检
产品审计报告模版.md 模板 创建项目内 产品审计报告.md,记录设计审核、产物审核和复审
产品问题记录模版.md 模板 创建项目内 产品问题记录.md,记录非审计来源产品问题闭环
需求文档范本.md 范本 供正式需求文档参考,不强制每个事项都复制

3. 推荐使用顺序

创建产品体系时:

  1. 先读 ../../全局规范.md
  2. 再读 产品规范.md
  3. 产品环境创建指南.md 在项目中创建 pro-doc/
  4. 本地 产品规范.md产品审核规范.md需求规范.md产品环境创建指南.md 的短引用模板创建,不复制 common 正文。
  5. 用模板创建本地 产品总纲.md产品设计.md产品执行日志.md产品审计报告.md产品问题记录.md
  6. 大量修改时参考 产品方案文档范本.md 写产品方案,并先过产品审核。
  7. 第一版复杂产品交付时参考 产品架构文档范本.md产品模块说明文档范本.md产品核心流程文档范本.md 写三大文档,并先过产品审核。
  8. 如要产出正式需求文档,按 需求规范.md需求文档范本.md 编写,并进入产品审核。

项目内产品文档默认 append-only 维护:最新产品事项、设计、执行、审计、问题追加到对应文件末尾。