创建人员:Codex
文件职责:指导项目管理员在具体项目中创建需求体系环境、基础文档、审计入口和项目配置登记。
管理规范/模板:../../全局规范.md;../../体系说明.md;需求规范.md。
引用文件:需求规范.md;需求审核规范.md;需求总纲模版.md;需求设计模版.md;需求方案文档范本.md;需求架构文档范本.md;需求模块说明文档范本.md;需求核心流程文档范本.md;需求执行日志模版.md;需求审计报告模版.md;需求问题记录模版.md;需求文档范本.md。
记录方式:创建指南;需求体系创建流程变化时更新。
项目管理员决定启用需求体系时,按本指南执行。
需求体系用于承接需求、策略、业务规则等文档工作。
创建前应明确:
前置检查:
项目配置清单.md、项目执行日志.md、项目变更记录.md。common/project-doc/项目环境创建指南.md 初始化项目体系。pro-doc/。默认创建:
pro-doc/
pro-doc/tmp/
说明:
pro-doc/ 存需求文档、策略说明、规则说明、总纲、设计、日志、审计和问题记录。pro-doc/tmp/ 存临时草稿,不得作为正式产物入口。在项目 pro-doc/ 下创建:
目录导读.md需求规范.md需求审核规范.md需求总纲.md需求设计.md需求执行日志.md需求审计报告.md需求问题记录.md本地 需求规范.md、需求审核规范.md 默认只引用 common 对应规范,可以没有额外补充。
需求方案文档范本.md、需求架构文档范本.md、需求模块说明文档范本.md、需求核心流程文档范本.md 是 common 参考范本,不是项目初始化必须复制的本地文档。
只有在对应事项需要时才创建具体文档:
需求方案-<事项ID>.md。需求架构-<事项ID>.md、需求模块说明-<事项ID>.md、需求核心流程-<事项ID>.md。不得把 common 规范全文复制到本地规范。创建本地规范时使用下面的短引用结构。
本地 需求规范.md 初始内容:
# 需求规范
创建人员:<创建人员>
文件职责:记录本项目需求体系必须遵守的本地规范。本文件引用 common/pro-doc/需求规范.md,不得削弱 common 需求规范硬约束。
管理规范/模板:../../common/pro-doc/需求规范.md
引用文件:需求总纲.md;需求设计.md;需求执行日志.md;需求审计报告.md;需求问题记录.md;需求文档范本.md
记录方式:本地规范;如有项目特化需求流程或补充规则,追加到本文件。
## 1. 基本口径
本项目所有需求 AI 和需求审核员必须同时遵守 ../../common/pro-doc/需求规范.md 和本文件。
本文件当前没有额外补充规则。如后续设计本地需求流程,必须满足 common 需求规范硬约束;流程通过审核后,执行时以本地流程为准。
## 2. 核心需求文档作用
| 文档 | 作用 |
|---|---|
| 需求总纲.md | 记录需求事项、策略事项、业务规则事项的背景、目标、边界、状态和结论 |
| 需求设计.md | 记录需求事项设计、分流判断、输入输出、验收和下游交接 |
| 需求执行日志.md | 记录需求事项执行关键节点、产物和自检 |
| 需求审计报告.md | 记录设计审核、产物审核、需求审核和复审结论 |
| 需求问题记录.md | 记录非审计来源需求问题;审计问题只记录索引 |
本地 需求审核规范.md 初始内容:
# 需求审核规范
创建人员:<创建人员>
文件职责:记录本项目需求审核员必须遵守的本地审核规范。本文件引用 common/pro-doc/需求审核规范.md,不得削弱 common 需求审核规范硬约束。
管理规范/模板:../../common/pro-doc/需求审核规范.md
引用文件:需求规范.md;需求审计报告.md;需求问题记录.md
记录方式:本地审核规范;如有项目特化审核流程或补充规则,追加到本文件。
## 1. 基本口径
本项目所有需求审核员必须同时遵守 ../../common/pro-doc/需求审核规范.md 和本文件。
本文件当前没有额外补充规则。如后续设计本地需求审核流程,必须满足 common 需求审核规范硬约束;流程通过审核后,执行时以本地流程为准。
在项目根目录 项目配置清单.md 中更新:
pro-doc/。../common/pro-doc/需求规范.md、../common/pro-doc/需求审核规范.md。pro-doc/需求规范.md、pro-doc/需求审核规范.md。同时在项目执行日志和项目变更记录中登记启用动作。
需求体系创建完成后,项目管理员或需求审核员应做一次轻量校验。
检查:
pro-doc/、pro-doc/tmp/ 存在。目录导读.md、需求规范.md、需求审核规范.md、需求总纲.md、需求设计.md、需求执行日志.md、需求审计报告.md、需求问题记录.md 存在。检查:
项目配置清单.md 已登记需求体系启用状态、目录、common 规范、本地规范、需求 AI、需求审核员。pro-doc/目录导读.md 能指到总纲、设计、执行日志、审计报告和问题记录。用一个不代表真实业务结论的测试事项,例如 PRO-SMOKE-001,做证据链 dry-run。
最小链路:
需求总纲:记录 PRO-SMOKE-001 的来源、目标、边界
-> 需求设计:记录 DESIGN-PRO-SMOKE-001 的方案和验收
-> 需求执行日志:记录 RUN-PRO-SMOKE-001 的关键步骤和产物位置
-> 需求审计报告:记录 AUDIT-PRO-SMOKE-001 的初始化 / dry-run 审计结论
-> 需求问题记录:仅在存在非审计来源问题或需要审计问题索引时使用
通过标准:
需求环境可用,至少满足:
pro-doc/ 存在。禁止: