创建人员:Codex
文件职责:说明 common/pro-doc 目录下需求体系规范、创建指南、模板和需求写作规范的用途。
管理规范/模板:../../全局规范.md;../../体系说明.md;需求规范.md。
引用文件:需求规范.md;需求环境创建指南.md;需求审核规范.md;本目录下全部 *模版.md 和 *范本.md 文件。
记录方式:目录入口文档;新增或删除本目录正式文档时同步更新。
本目录保存通用需求体系文档。
需求体系负责管理需求、策略、业务规则、方法论转需求等事项。它回答:
需求体系不写代码,不跑实验,不替代案例分析。需要代码时进入开发体系的需求开发工作区;需要验证时进入实验体系;需要逐案分析时进入案例分析体系。
| 文件 | 类型 | 作用 |
|---|---|---|
| 需求规范.md | 全局需求规范 | 说明需求体系定位、流程、文档职责、需求写作、审核边界和问题闭环 |
| 需求环境创建指南.md | 创建指南 | 指导项目管理员在具体项目中创建需求体系 |
| 需求审核规范.md | 审核规范 | 定义需求设计审核、需求产物审核、需求清晰度审核和闭环规则 |
| 需求总纲模版.md | 模板 | 创建项目内 需求总纲.md,记录需求事项背景、目标、状态和结论 |
| 需求设计模版.md | 模板 | 创建项目内 需求设计.md,记录需求方案、需求拆解、输入输出和验收方式 |
| 需求方案文档范本.md | 范本 | 大量需求修改时参考,先讲清修改背景、内容、影响和验收 |
| 需求架构文档范本.md | 范本 | 第一版复杂需求交付时参考,说明整体结构和模块关系 |
| 需求模块说明文档范本.md | 范本 | 第一版复杂需求交付时参考,说明模块功能、作用、边界和上下游 |
| 需求核心流程文档范本.md | 范本 | 第一版复杂需求交付时参考,说明主流程、分支和交付链路 |
| 需求执行日志模版.md | 模板 | 创建项目内 需求执行日志.md,记录需求事项执行、产物路径、偏离和自检 |
| 需求审计报告模版.md | 模板 | 创建项目内 需求审计报告.md,记录设计审核、产物审核和复审 |
| 需求问题记录模版.md | 模板 | 创建项目内 需求问题记录.md,记录非审计来源需求问题闭环 |
| 需求文档范本.md | 范本 | 供正式需求文档参考,不强制每个事项都复制 |
创建需求体系时:
../../全局规范.md。需求规范.md。需求环境创建指南.md 在项目中创建 pro-doc/。需求规范.md、需求审核规范.md 用 需求环境创建指南.md 的短引用模板创建,不复制 common 正文。需求总纲.md、需求设计.md、需求执行日志.md、需求审计报告.md、需求问题记录.md。需求方案文档范本.md 写需求方案,并先过需求审核。需求架构文档范本.md、需求模块说明文档范本.md、需求核心流程文档范本.md 写三大文档,并先过需求审核。需求规范.md 和 需求文档范本.md 编写,并进入需求审核。项目内需求文档默认 append-only 维护:最新需求事项、设计、执行、审计、问题追加到对应文件末尾。