From 61dd274b761b476395c763614fe40be81757b61a Mon Sep 17 00:00:00 2001 From: 1 <wentingyear@gmail.com> Date: Wed, 03 Jun 2026 20:49:48 +0800 Subject: [PATCH] Update manage system docs --- project-ai-workspace-check/pro-doc/目录导读.md | 19 project-g/ai-morgan/工作说明.md | 14 project-ai-workspace-check/pro-doc/需求审计报告.md | 15 common/dev-doc/编码规范.md | 10 project-ai-workspace-check/dev-doc/开发审计规范.md | 12 project A/项目规范.md | 4 全局规范.md | 16 common/pro-doc/需求模块说明文档范本.md | 16 project-ai-workspace-check/pro-doc/需求总纲.md | 14 project-ai-workspace-check/ai-omar/工作说明.md | 62 ++ common/dev-doc/目录导读.md | 4 project-ai-workspace-check/项目事项总纲.md | 17 project-e/项目配置清单.md | 2 common/pro-doc/需求审计报告模版.md | 16 project-ai-workspace-check/dev-doc/开发事项计划.md | 16 common/project-doc/目录导读.md | 2 project A/项目配置清单.md | 4 project-ai-workspace-check/dev-doc/开发执行日志.md | 16 project-g/项目配置清单.md | 8 体系说明.md | 34 project-ai-workspace-check/ai-lena/worklog/首次阅读反馈.md | 12 wuji-trade/项目配置清单.md | 6 common/dev-doc/开发事项总纲模版.md | 4 common/pro-doc/需求文档范本.md | 20 project-ai-workspace-check/pro-doc/需求执行日志.md | 16 common/pro-doc/需求规范.md | 32 common/project-doc/项目配置清单模版.md | 4 project-ai-workspace-check/dev-doc/编码规范.md | 12 project-g/项目事项计划.md | 4 common/pro-doc/需求环境创建指南.md | 190 ++++++ project-ai-workspace-check/项目执行日志.md | 18 管理系统说明.md | 29 project-ai-workspace-check/ai-omar/worklog/首次阅读反馈.md | 11 project-ai-workspace-check/dev-doc/开发问题记录.md | 10 common/pro-doc/需求总纲模版.md | 28 project-d/项目配置清单.md | 4 project-ai-workspace-check/项目配置清单.md | 55 + common/project-doc/项目环境创建指南.md | 4 project-ai-workspace-check/dev-doc/pro-doc/开发工作区说明.md | 20 common/ana-doc/案例分析规范.md | 4 project-ai-workspace-check/dev-doc/开发审计报告.md | 16 common/pro-doc/需求设计模版.md | 48 common/pro-doc/需求执行日志模版.md | 18 project-ai-workspace-check/pro-doc/需求规范.md | 12 project B/项目规范.md | 4 project-g/ai-morgan/worklog/20260603_工作说明首次阅读反馈.md | 10 project-ai-workspace-check/项目变更记录.md | 15 common/ai-workplace/AI工作空间创建指南.md | 36 project-ai-workspace-check/项目总览.md | 26 project-ai-workspace-check/dev-doc/开发事项总纲.md | 15 体系创建流程.md | 4 common/pro-doc/需求审核规范.md | 40 project-g/项目事项审计报告.md | 8 common/pro-doc/需求问题记录模版.md | 12 project-ai-workspace-check/dev-doc/目录导读.md | 18 project-ai-workspace-check/pro-doc/需求设计.md | 16 common/pro-doc/需求核心流程文档范本.md | 26 project-ai-workspace-check/pro-doc/需求问题记录.md | 10 project-g/项目变更记录.md | 6 体系差异.md | 16 common/pro-doc/需求方案文档范本.md | 20 common/dev-doc/开发环境创建指南.md | 6 /dev/null | 303 ---------- project-g/项目执行日志.md | 10 project-ai-workspace-check/ai-lena/工作说明.md | 64 ++ project-ai-workspace-check/项目事项计划.md | 17 project-ai-workspace-check/dev-doc/pro-doc/目录导读.md | 16 common/pro-doc/目录导读.md | 67 +- project-ai-workspace-check/pro-doc/需求审核规范.md | 11 project-ai-workspace-check/项目事项审计报告.md | 17 common/pro-doc/需求架构文档范本.md | 28 project-ai-workspace-check/项目问题记录.md | 10 project C/项目配置清单.md | 2 project-ai-workspace-check/项目规范.md | 16 74 files changed, 1,114 insertions(+), 613 deletions(-) diff --git "a/common/ai-workplace/AI\345\267\245\344\275\234\347\251\272\351\227\264\345\210\233\345\273\272\346\214\207\345\215\227.md" "b/common/ai-workplace/AI\345\267\245\344\275\234\347\251\272\351\227\264\345\210\233\345\273\272\346\214\207\345\215\227.md" index c31eef5..4720637 100644 --- "a/common/ai-workplace/AI\345\267\245\344\275\234\347\251\272\351\227\264\345\210\233\345\273\272\346\214\207\345\215\227.md" +++ "b/common/ai-workplace/AI\345\267\245\344\275\234\347\251\272\351\227\264\345\210\233\345\273\272\346\214\207\345\215\227.md" @@ -1,4 +1,4 @@ -# AI 工作空间创建指南 +# AI 工作空间创建指南 创建人员：Codex 文件职责：指导项目管理员在某个项目中为指定 AI 创建工作空间、分配一个或多个角色，并生成该 AI 的 `工作说明.md`。 @@ -15,7 +15,7 @@ 1. 在某个项目里创建该 AI 的工作空间。 2. 根据该 AI 在项目中的一个或多个角色，生成或更新入口索引型 `工作说明.md`，让该 AI 快速知道自己的职责边界、目录入口和必须阅读的体系文档。 -本指南不替代项目体系、产品体系、开发体系、实验体系、案例分析体系或数据体系的创建指南。它只负责“AI 人员入场和角色配置”。 +本指南不替代项目体系、需求体系、开发体系、实验体系、案例分析体系或数据体系的创建指南。它只负责“AI 人员入场和角色配置”。 ## 2. 输入 @@ -26,7 +26,7 @@ | project_root | 项目根目录，例如 `project-x/` | | ai_name | AI 稳定名称，建议英文名或拼音小写 | | ai_display_name | 显示名称，可与 ai_name 相同 | -| roles | 一个或多个角色，例如 `产品 AI`、`开发 AI`、`实验员`、`审核员` | +| roles | 一个或多个角色，例如 `需求 AI`、`开发 AI`、`实验员`、`审核员` | | target_scopes | 角色绑定的体系和目标范围，例如 `实验开发 -> dev/exp-dev/`、`项目审核 -> 项目事项审计报告.md`、`实验审核 -> exp-doc/实验审计报告.md` | | is_reviewer | 是否承担审核员职责 | | assigned_by | 指派人 | @@ -53,16 +53,16 @@ | 泛角色 | 正确写法示例 | 绑定范围 | |---|---|---| | 开发 AI | 开发 AI（实验开发） | `dev/exp-dev/`；`dev-doc/exp-doc/` | -| 开发 AI | 开发 AI（产品/需求开发） | `dev/pro-dev/`；`dev-doc/pro-doc/` | +| 开发 AI | 开发 AI（需求开发） | `dev/pro-dev/`；`dev-doc/pro-doc/` | | 开发 AI | 开发 AI（案例分析开发） | `dev/ana-dev/`；`dev-doc/ana-doc/` | | 审核员 | 审核员（项目事项审核） | `项目事项审计报告.md` | | 审核员 | 审核员（实验审核） | `exp-doc/实验审计报告.md` | | 审核员 | 审核员（开发审核） | `dev-doc/开发审计报告.md` | -| 审核员 | 审核员（产品审核） | `pro-doc/产品审计报告.md` 或项目约定产品审核入口 | +| 审核员 | 审核员（需求审核） | `pro-doc/需求审计报告.md` 或项目约定需求审核入口 | 审核员不是只读审计规范。任何审核员都必须同时读取： -1. 被审体系的“怎么做”文档：例如产品规范、需求规范、实验规范、编码规范、项目规范、案例分析规范。 +1. 被审体系的“怎么做”文档：例如需求规范、实验规范、编码规范、项目规范、案例分析规范。 2. 审核体系的“怎么审”文档：例如需求审核入口、实验审计规范、开发审计规范、项目事项审计报告。 3. 被审对象的账本和证据链入口：例如总纲、设计/计划、执行日志、结果包索引、变更记录、问题记录。 4. 如果审核对象涉及具体目标工作区，还必须列出该目标工作区说明文档，例如 `dev-doc/<target>-doc/开发工作区说明.md`。 @@ -74,7 +74,7 @@ | 角色 | 默认职责 | 默认写权限范围 | |---|---|---| | 项目管理员 | 管理项目规范、配置清单、项目级账本、体系启用和项目级审计 | 项目根目录；该 AI 工作空间 | -| 产品 AI | 写需求、产品、策略、业务规则等文档 | `pro-doc/`；该 AI 工作空间 | +| 需求 AI | 写需求、策略、业务规则等文档 | `pro-doc/`；该 AI 工作空间 | | 开发 AI（指定体系开发） | 写指定体系的代码、测试、编码方案、开发日志和开发自检 | `dev/<target>-dev/`；`dev/<target>-dev/test/`；`dev-doc/<target>-doc/`；该 AI 工作空间 | | 实验员 | 设计和执行实验，维护实验文档、实验数据和结果包 | `exp-doc/`；`exp-data/`；该 AI 工作空间 | | 案例分析员 | 做案例分析，维护案例文档、图片、数据和执行链路 | `ana-doc/`；`ana-data/`；该 AI 工作空间 | @@ -85,7 +85,7 @@ | 组合角色 | 解释 | |---|---| -| 产品-开发 | 同一 AI 同时负责需求/产品文档和对应代码实现，角色应写成 `产品 AI；开发 AI（需求/产品开发）` | +| 需求-开发 | 同一 AI 同时负责需求文档和对应代码实现，角色应写成 `需求 AI；开发 AI（需求开发）` | | 实验-开发 | 同一 AI 同时负责实验设计/执行和实验相关脚本开发，角色应写成 `实验员；开发 AI（实验开发）` | | 案例分析-开发 | 同一 AI 同时负责案例分析和案例工具开发，角色应写成 `案例分析员；开发 AI（案例分析开发）` | | 项目管理员-审核员 | 同一 AI 负责项目配置和项目级审计，角色应写成 `项目管理员；审核员（项目事项审核）` | @@ -98,7 +98,7 @@ | 开发角色 | 必读文档 | |---|---| -| 产品-开发 | 项目本地 `pro-doc/产品规范.md`、`pro-doc/需求规范.md`、相关产品总纲 / 需求文档 / 产品方案 / 三大产品文档；项目本地 `dev-doc/编码规范.md`、`dev-doc/开发审计规范.md` | +| 需求-开发 | 项目本地 `pro-doc/需求规范.md`、相关需求总纲 / 需求文档 / 需求方案 / 三大需求文档；项目本地 `dev-doc/编码规范.md`、`dev-doc/开发审计规范.md` | | 实验-开发 | 项目本地 `exp-doc/实验规范.md`、`exp-doc/实验审核规范.md`、相关实验总纲 / 实验设计；项目本地 `dev-doc/编码规范.md`、`dev-doc/开发审计规范.md` | | 案例分析-开发 | 项目本地 `ana-doc/案例分析规范.md`、`ana-doc/案例分析审核规范.md`、相关案例总纲 / 案例设计或案例流程；项目本地 `dev-doc/编码规范.md`、`dev-doc/开发审计规范.md` | | 项目工具开发 | 项目本地 `项目规范.md`、`项目配置清单.md`、相关项目事项总纲 / 项目事项计划；项目本地 `dev-doc/编码规范.md`、`dev-doc/开发审计规范.md` | @@ -107,13 +107,13 @@ | 审核角色 | 必读文档 | |---|---| -| 产品审核员 | 项目本地 `pro-doc/产品规范.md`、`pro-doc/需求规范.md`、`pro-doc/产品审核规范.md`、被审产品事项账本和上游聊天 / 文档证据 | +| 需求审核员 | 项目本地 `pro-doc/需求规范.md`、`pro-doc/需求审核规范.md`、被审需求事项账本和上游聊天 / 文档证据 | | 开发审核员 | 项目本地 `dev-doc/编码规范.md`、`dev-doc/开发审计规范.md`、被审开发事项账本、需求文档和开发产物证据 | | 实验审核员 | 项目本地 `exp-doc/实验规范.md`、`exp-doc/实验审核规范.md`、被审实验总纲 / 实验设计 / 执行日志 / 结果包 | | 案例分析审核员 | 项目本地 `ana-doc/案例分析规范.md`、`ana-doc/案例分析审核规范.md`、被审案例账本 / 执行记录 / 图片或数据证据 | | 项目事项审核员 | 项目本地 `项目规范.md`、`项目配置清单.md`、项目事项总纲 / 项目事项计划 / 项目执行日志 / 项目变更记录 | -如果是组合审核角色，例如“产品-开发-审核员”，工作说明必须同时列出产品规范、编码规范、产品审核规范、开发审计规范，以及对应产品事项和开发事项的账本入口。不得只列审计报告或只列审核规范。 +如果是组合审核角色，例如“需求-开发-审核员”，工作说明必须同时列出需求规范、编码规范、需求审核规范、开发审计规范，以及对应需求事项和开发事项的账本入口。不得只列审计报告或只列审核规范。 组合角色必须避免“自己执行、自己无条件通过”的问题。若同一 AI 同时是执行者和审核员，`工作说明.md` 必须要求它在审计报告中明确标注“自审”，并列出可复核证据；重大事项应优先安排独立审核员。 @@ -158,7 +158,7 @@ 1. 在“AI 角色与权限”表中新增或更新该 AI。 2. 在“目录映射”表中登记 `ai-<ai_name>/`。 -3. 如角色涉及开发，必须写清是实验开发、需求/产品开发、案例分析开发或其他具体开发目标，并绑定目标目录；不得只写“开发 AI”。 +3. 如角色涉及开发，必须写清是实验开发、需求开发、案例分析开发或其他具体开发目标，并绑定目标目录；不得只写“开发 AI”。 4. 如角色涉及审核，必须写清是项目事项审核、实验审核、开发审核、需求审核或其他具体审核目标，并绑定审计入口；不得只写“审核员”。 5. 如角色涉及目标开发工作区，必须同步调用开发环境创建指南创建该 target workspace；未创建时，只能登记候选开发角色，不得登记为正式开发角色。 6. 在“变更索引”中追加一条变更 ID。 @@ -311,7 +311,7 @@ 检查： -1. 产品 AI 写权限对应的 `pro-doc/` 是否已启用；未启用时只能写工作空间草稿。 +1. 需求 AI 写权限对应的 `pro-doc/` 是否已启用；未启用时只能写工作空间草稿。 2. 实验员写权限对应的 `exp-doc/`、`exp-data/` 是否已启用；未启用时只能写工作空间草稿。 3. 案例分析员写权限对应的 `ana-doc/`、`ana-data/` 是否已启用；未启用时只能写工作空间草稿。 4. 开发 AI 的目标开发工作区是否已经创建；正式开发角色不得停留在 target_workspace 未创建状态。 @@ -335,6 +335,14 @@ 10. 如果是审核员，是否写清审核体系、审计报告入口、只读边界和不得直接修改被审计产物。 11. 如果是审核员，是否同时列出被审体系规范、审计规范 / 审计报告入口、被审对象账本入口。 12. 是否要求 AI 首次阅读后在 `worklog/` 记录理解反馈和疑问。 + +组合角色还必须按角色类型做专项校验： + +1. 需求-开发角色：`工作说明.md` 必须同时列出 `pro-doc/需求规范.md`、相关需求事项账本或需求文档入口、`dev-doc/编码规范.md`、`dev-doc/开发审计规范.md`、`dev/pro-dev/`、`dev-doc/pro-doc/`。 +2. 实验-开发角色：`工作说明.md` 必须同时列出 `exp-doc/实验规范.md`、`exp-doc/实验审核规范.md`、相关实验总纲 / 实验设计入口、`dev-doc/编码规范.md`、`dev-doc/开发审计规范.md`、目标实验开发工作区。 +3. 案例分析-开发角色：`工作说明.md` 必须同时列出案例分析规范、案例审核规范、相关案例账本入口、`dev-doc/编码规范.md`、`dev-doc/开发审计规范.md`、目标案例开发工作区。 +4. 需求-开发-审核员：`工作说明.md` 必须同时列出需求规范、需求审核规范、编码规范、开发审计规范、需求审计报告、开发审计报告、需求事项账本入口、开发事项账本入口；不得只列审计报告或只列审核规范。 +5. 任一组合审核员：必须列出它要审核的每个体系的“怎么做”文档和“怎么审”文档。如果漏任一体系规范，校验不通过。 ### 6.5 项目级日志和变更校验 @@ -385,7 +393,7 @@ 6. 审核员直接修改被审计产物。 7. AI 工作空间里堆放正式产物，正式账本找不到。 8. 角色变更没有写项目变更记录。 -9. 只写“开发 AI”，没有写清实验开发、需求/产品开发或案例分析开发等具体开发范围。 +9. 只写“开发 AI”，没有写清实验开发、需求开发或案例分析开发等具体开发范围。 10. 只写“审核员”，没有写清项目事项审核、实验审核、开发审核或需求审核等具体审核范围。 11. 正式指派了开发角色，但没有同步创建对应 target workspace。 12. 在 `工作说明.md` 里复制体系规范细节，导致工作说明变成第二套规范。 diff --git "a/common/ana-doc/\346\241\210\344\276\213\345\210\206\346\236\220\350\247\204\350\214\203.md" "b/common/ana-doc/\346\241\210\344\276\213\345\210\206\346\236\220\350\247\204\350\214\203.md" index 4079a84..eb86dd5 100644 --- "a/common/ana-doc/\346\241\210\344\276\213\345\210\206\346\236\220\350\247\204\350\214\203.md" +++ "b/common/ana-doc/\346\241\210\344\276\213\345\210\206\346\236\220\350\247\204\350\214\203.md" @@ -1,4 +1,4 @@ -# 案例分析规范 +# 案例分析规范 创建人员：Codex 文件职责：定义案例分析体系的定位、核心流程、证据链要求、文档职责、审计闭环和问题处理边界。 @@ -13,7 +13,7 @@ 案例可以来自： 1. 方法论或笔记。 -2. 交易、产品、用户、工程、业务流程。 +2. 交易、需求、用户、工程、业务流程。 3. 样本数据。 4. 人工标注。 5. AI 发现的异常或候选。 diff --git "a/common/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262\346\250\241\347\211\210.md" "b/common/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262\346\250\241\347\211\210.md" index 8fe1c4a..28fd572 100644 --- "a/common/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262\346\250\241\347\211\210.md" +++ "b/common/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262\346\250\241\347\211\210.md" @@ -1,4 +1,4 @@ -# 开发事项总纲 +# 开发事项总纲 创建人员：<创建人员> 文件职责：作为目标开发工作区的滚动账本，记录开发事项背景、来源、目标、边界、状态和结论。 @@ -17,7 +17,7 @@ ### <YYYY-MM-DD HH:mm:ss> <DEV-ITEM-ID>：<事项标题> 来源体系： -产品 / 实验 / 案例分析 / 项目 / 数据 / 其他 +需求 / 实验 / 案例分析 / 项目 / 数据 / 其他 来源聊天记录： ```text diff --git "a/common/dev-doc/\345\274\200\345\217\221\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" "b/common/dev-doc/\345\274\200\345\217\221\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" index e35db71..9dc9065 100644 --- "a/common/dev-doc/\345\274\200\345\217\221\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" +++ "b/common/dev-doc/\345\274\200\345\217\221\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" @@ -1,4 +1,4 @@ -# 开发环境创建指南 +# 开发环境创建指南 创建人员：Codex 文件职责：指导项目管理员在具体项目中创建默认开发体系根目录，以及按需为某个目标体系创建开发工作区。 @@ -92,7 +92,7 @@ 示例： ```text -产品开发：dev/pro-dev/、dev/pro-dev/test/、dev-doc/pro-doc/ +需求开发：dev/pro-dev/、dev/pro-dev/test/、dev-doc/pro-doc/ 实验开发：dev/exp-dev/、dev/exp-dev/test/、dev-doc/exp-doc/ 案例分析开发：dev/ana-dev/、dev/ana-dev/test/、dev-doc/ana-doc/ ``` @@ -343,7 +343,7 @@ 禁止： 1. 把所有代码直接放在 `dev/` 根目录。 -2. 把产品需求文档放进 `dev-doc/<target>-doc/`。 +2. 把需求文档放进 `dev-doc/<target>-doc/`。 3. 把编码方案当成需求文档。 4. 方案未审就做重型实现。 5. 审核员改业务代码或测试代码。 diff --git "a/common/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/common/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" index 06566f8..261a370 100644 --- "a/common/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" +++ "b/common/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -1,4 +1,4 @@ -# 开发体系目录导读 +# 开发体系目录导读 创建人员：Codex 文件职责：说明 `common/dev-doc` 下开发体系公共规范、模板和创建指南的用途。 @@ -12,7 +12,7 @@ 开发必须绑定目标体系或目标事项，例如： -1. 产品 / 需求开发：实现产品、需求、策略文档对应的代码。 +1. 需求 / 需求开发：实现需求、策略文档对应的代码。 2. 实验开发：实现实验脚本、回测、图表、数据处理和校验工具。 3. 案例分析开发：实现案例图表、账本、回放和审计辅助工具。 4. 项目工具开发：实现项目初始化、索引、归档和检查工具。 diff --git "a/common/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" "b/common/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" index b2c8ad9..960f07b 100644 --- "a/common/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" +++ "b/common/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" @@ -1,4 +1,4 @@ -# 编码规范 +# 编码规范 创建人员：Codex 文件职责：定义通用编码注意事项、编码流程、验收方式、问题修复原则，适用于管理体系下的多个项目。 @@ -44,7 +44,7 @@ 常见映射： -1. 产品 / 需求开发：`dev/pro-dev/`、`dev/pro-dev/test/`、`dev-doc/pro-doc/`。 +1. 需求 / 需求开发：`dev/pro-dev/`、`dev/pro-dev/test/`、`dev-doc/pro-doc/`。 2. 实验开发：`dev/exp-dev/`、`dev/exp-dev/test/`、`dev-doc/exp-doc/`。 3. 案例分析开发：`dev/ana-dev/`、`dev/ana-dev/test/`、`dev-doc/ana-doc/`。 @@ -140,14 +140,14 @@ 编码前按以下顺序执行： 1. 确认事项编号、任务目标、责任模块。 -2. 阅读相关需求文档、产品方案、架构文档、模块说明文档、核心流程文档、流程图、接口文档；没有的上游文档要说明“不适用”。 +2. 阅读相关需求文档、需求方案、架构文档、模块说明文档、核心流程文档、流程图、接口文档；没有的上游文档要说明“不适用”。 3. 判断本次是需求问题、代码问题、数据问题，还是流程问题。 4. 明确改动范围，列出会被影响的模块和产物。 5. 如属于多模块或长流程改动，先写代码编写方案。 6. 明确验收方式，包括最小样本、边界样本、失败样本、全量样本。 7. 再开始编码。 -如果本次是产品体系交付到开发的事项，还必须先读项目本地 `pro-doc/产品规范.md`、`pro-doc/需求规范.md`，以及需求文档引用的产品方案、架构文档、模块说明文档、核心流程文档。若这些上游产品文档缺失或互相冲突，应按产品/需求问题退回，不得靠代码补口径。 +如果本次是需求体系交付到开发的事项，还必须先读项目本地 `pro-doc/需求规范.md`、`pro-doc/需求规范.md`，以及需求文档引用的需求方案、架构文档、模块说明文档、核心流程文档。若这些上游需求文档缺失或互相冲突，应按需求问题退回，不得靠代码补口径。 如果本次是实验开发、案例分析开发或项目工具开发，也必须读取对应目标体系规范和事项账本；开发规范只约束怎么写代码，不替代目标体系的业务流程。 @@ -166,7 +166,7 @@ 这类任务通常不需要先写需求文档，也不需要写代码编写方案。 -产品体系正式交付到开发的事项，默认不适用“无需求文档的轻量实现”。如果产品侧只给了口头要求或草案，应先回到产品/需求流程形成可审计需求，再进入开发。 +需求体系正式交付到开发的事项，默认不适用“无需求文档的轻量实现”。如果需求侧只给了口头要求或草案，应先回到需求流程形成可审计需求，再进入开发。 执行流程： diff --git "a/common/pro-doc/\344\272\247\345\223\201\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" "b/common/pro-doc/\344\272\247\345\223\201\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" deleted file mode 100644 index 95c6dcb..0000000 --- "a/common/pro-doc/\344\272\247\345\223\201\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" +++ /dev/null @@ -1,209 +0,0 @@ -# 产品环境创建指南 - -创建人员：Codex -文件职责：指导项目管理员在具体项目中创建产品体系环境、基础文档、审计入口和项目配置登记。 -管理规范/模板：../../全局规范.md；../../体系说明.md；产品规范.md。 -引用文件：产品规范.md；产品审核规范.md；需求规范.md；产品总纲模版.md；产品设计模版.md；产品方案文档范本.md；产品架构文档范本.md；产品模块说明文档范本.md；产品核心流程文档范本.md；产品执行日志模版.md；产品审计报告模版.md；产品问题记录模版.md；需求文档范本.md。 -记录方式：创建指南；产品体系创建流程变化时更新。 - -## 1. 使用场景 - -项目管理员决定启用产品体系时，按本指南执行。 - -产品体系用于承接需求、产品、策略、业务规则等文档工作。 - -## 2. 输入 - -创建前应明确： - -1. 项目名称和项目根目录。 -2. 产品体系是否启用。 -3. 产品 AI。 -4. 产品审核员。 -5. 是否需要立即创建第一个产品事项。 - -前置检查： - -1. 项目根目录应已有 `项目配置清单.md`、`项目执行日志.md`、`项目变更记录.md`。 -2. 如果项目级入口不存在，必须先按 `common/project-doc/项目环境创建指南.md` 初始化项目体系。 -3. 不允许绕过项目配置清单直接创建孤立的 `pro-doc/`。 - -## 3. 创建目录 - -默认创建： - -```text -pro-doc/ -pro-doc/tmp/ -``` - -说明： - -1. `pro-doc/` 存产品文档、需求文档、策略说明、规则说明、总纲、设计、日志、审计和问题记录。 -2. `pro-doc/tmp/` 存临时草稿，不得作为正式产物入口。 - -## 4. 创建基础文档 - -在项目 `pro-doc/` 下创建： - -1. `目录导读.md` -2. `产品规范.md` -3. `产品审核规范.md` -4. `需求规范.md` -5. `产品总纲.md` -6. `产品设计.md` -7. `产品执行日志.md` -8. `产品审计报告.md` -9. `产品问题记录.md` - -本地 `产品规范.md`、`产品审核规范.md`、`需求规范.md` 默认只引用 common 对应规范，可以没有额外补充。 - -`产品方案文档范本.md`、`产品架构文档范本.md`、`产品模块说明文档范本.md`、`产品核心流程文档范本.md` 是 common 参考范本，不是项目初始化必须复制的本地文档。 - -只有在对应事项需要时才创建具体文档： - -1. 大量产品修改：创建具体 `产品方案-<事项ID>.md`。 -2. 第一版复杂产品交付：创建具体 `产品架构-<事项ID>.md`、`产品模块说明-<事项ID>.md`、`产品核心流程-<事项ID>.md`。 -3. 少量修改或轻量首版交付：不强制创建这些文档，直接进入需求文档书写流程。 - -不得把 common 规范全文复制到本地规范。创建本地规范时使用下面的短引用结构。 - -本地 `产品规范.md` 初始内容： - -```text -# 产品规范 - -创建人员：<创建人员> -文件职责：记录本项目产品体系必须遵守的本地规范。本文件引用 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` 初始内容： - -```text -# 产品审核规范 - -创建人员：<创建人员> -文件职责：记录本项目产品审核员必须遵守的本地审核规范。本文件引用 common/pro-doc/产品审核规范.md，不得削弱 common 产品审核规范硬约束。 -管理规范/模板：../../common/pro-doc/产品审核规范.md -引用文件：产品规范.md；产品审计报告.md；产品问题记录.md -记录方式：本地审核规范；如有项目特化审核流程或补充规则，追加到本文件。 - -## 1. 基本口径 - -本项目所有产品审核员必须同时遵守 ../../common/pro-doc/产品审核规范.md 和本文件。 - -本文件当前没有额外补充规则。如后续设计本地产品审核流程，必须满足 common 产品审核规范硬约束；流程通过审核后，执行时以本地流程为准。 -``` - -本地 `需求规范.md` 初始内容： - -```text -# 需求规范 - -创建人员：<创建人员> -文件职责：记录本项目需求文档写作和审核的本地规范。本文件引用 common/pro-doc/需求规范.md，不得削弱 common 需求规范硬约束。 -管理规范/模板：../../common/pro-doc/需求规范.md -引用文件：产品规范.md；产品审核规范.md；../../common/pro-doc/需求文档范本.md -记录方式：本地需求规范；如有项目特化需求写作规则，追加到本文件。 - -## 1. 基本口径 - -本项目所有需求文档必须同时遵守 ../../common/pro-doc/需求规范.md 和本文件。 - -本文件当前没有额外补充规则。如后续补充本地需求写作口径，不得导致需求过重、验收过重或实现分叉。 -``` - -## 5. 更新项目配置清单 - -在项目根目录 `项目配置清单.md` 中更新： - -1. 产品体系启用状态为“是”。 -2. 目录为 `pro-doc/`。 -3. common 规范为 `../common/pro-doc/产品规范.md`、`../common/pro-doc/需求规范.md`。 -4. 本地规范为 `pro-doc/产品规范.md`、`pro-doc/需求规范.md`。 -5. 产品 AI 和产品审核员。 - -同时在项目执行日志和项目变更记录中登记启用动作。 - -## 6. 体系创建校验方案 - -产品体系创建完成后，项目管理员或产品审核员应做一次轻量校验。 - -### 6.1 目录和文档校验 - -检查： - -1. `pro-doc/`、`pro-doc/tmp/` 存在。 -2. `目录导读.md`、`产品规范.md`、`产品审核规范.md`、`需求规范.md`、`产品总纲.md`、`产品设计.md`、`产品执行日志.md`、`产品审计报告.md`、`产品问题记录.md` 存在。 -3. 每个正式文档都有：创建人员、文件职责、管理规范/模板、引用文件、记录方式。 -4. 本地规范明确引用 common 对应规范，并说明不得削弱 common 硬约束。 -5. 不存在从其他项目复制来的具体需求、旧路径、旧结论或旧业务内容。 - -### 6.2 项目配置和入口校验 - -检查： - -1. 项目根目录 `项目配置清单.md` 已登记产品体系启用状态、目录、common 规范、本地规范、产品 AI、产品审核员。 -2. 项目执行日志记录了启用产品体系的动作。 -3. 项目变更记录已登记产品体系启用。 -4. `pro-doc/目录导读.md` 能指到总纲、设计、执行日志、审计报告和问题记录。 - -### 6.3 证据链 dry-run 校验 - -用一个不代表真实业务结论的测试事项，例如 `PRO-SMOKE-001`，做证据链 dry-run。 - -最小链路： - -```text -产品总纲：记录 PRO-SMOKE-001 的来源、目标、边界 --> 产品设计：记录 DESIGN-PRO-SMOKE-001 的方案和验收 --> 产品执行日志：记录 RUN-PRO-SMOKE-001 的关键步骤和产物位置 --> 产品审计报告：记录 AUDIT-PRO-SMOKE-001 的初始化 / dry-run 审计结论 --> 产品问题记录：仅在存在非审计来源问题或需要审计问题索引时使用 -``` - -通过标准： - -1. 各文档之间的 ID 能互相引用。 -2. 人或 AI 能从产品总纲一路追到设计、执行日志和审计报告。 -3. 如果没有真实产品产物，执行日志要明确写“dry-run，无真实业务产物”。 -4. 审计问题主记录写在产品审计报告；产品问题记录不被误用成审计问题主账。 - -## 7. 完成标准 - -产品环境可用，至少满足： - -1. `pro-doc/` 存在。 -2. 本地产品规范、审核规范、需求规范、总纲、设计、执行日志、审计报告、问题记录存在。 -3. 项目配置清单已登记产品体系。 -4. 体系创建校验通过。 -5. 初始化审计通过。 - -## 8. 禁止事项 - -禁止： - -1. 只创建目录不创建入口文档。 -2. 未做设计审核就把正式需求交给开发。 -3. 把临时草稿当正式需求。 -4. 把其他项目的需求文档复制进新项目当正式产物。 -5. 把需求写成过重的发布 gate 系统。 diff --git "a/common/pro-doc/\344\272\247\345\223\201\350\247\204\350\214\203.md" "b/common/pro-doc/\344\272\247\345\223\201\350\247\204\350\214\203.md" deleted file mode 100644 index cfe2d7a..0000000 --- "a/common/pro-doc/\344\272\247\345\223\201\350\247\204\350\214\203.md" +++ /dev/null @@ -1,303 +0,0 @@ -# 产品规范 - -创建人员：Codex -文件职责：定义通用产品体系的定位、核心流程、文档职责、产品事项边界、审核闭环和与开发/实验/案例分析体系的关系。 -管理规范/模板：../../全局规范.md；../../体系说明.md；../../体系创建流程.md。 -引用文件：需求规范.md；产品环境创建指南.md；产品审核规范.md；产品总纲模版.md；产品设计模版.md；产品方案文档范本.md；产品架构文档范本.md；产品模块说明文档范本.md；产品核心流程文档范本.md；产品执行日志模版.md；产品审计报告模版.md；产品问题记录模版.md；需求文档范本.md。 -记录方式：全局产品体系规范；产品体系流程、文档职责或审核口径变化时更新。 - -## 1. 定位 - -产品体系管理产品、需求、策略和业务规则类事项。 - -它负责： - -1. 把聊天要求、方法论、业务想法、实验结论、案例结论整理成可审计的产品事项。 -2. 形成清楚的产品方案、需求文档、策略说明或规则说明。 -3. 判断产物是否能进入开发、实验、案例分析或项目管理。 -4. 保留产品事项的来源、设计、执行、产物、审计和问题闭环。 - -它不负责： - -1. 写代码。 -2. 跑实验。 -3. 做案例分析。 -4. 维护项目级配置。 -5. 把未经审核的想法直接交给开发。 - -## 2. 核心原则 - -1. 产品事项必须能追到来源聊天记录或上游文档。 -2. 产品设计必须说明目标、边界、输入、输出、消费方和验收方式。 -3. 审核通过前，产品产物不能进入正式开发或正式实验。 -4. 小需求走轻流程，重型系统需求走完整流程。 -5. 不把诊断项、建议项、边角料写成主流程硬要求。 -6. 如果产品事项要转成需求文档，需求文档必须遵守 `需求规范.md`。 -7. 如果产品事项要进入代码实现，必须进入开发体系。 - -## 3. 核心流程 - -产品体系分四类主流程，不同规模不要混用。 - -### 3.1 产品大量修改流程 - -适用场景： - -1. 修改范围跨多个模块、多个流程或多个文档。 -2. 修改会改变产品核心口径、核心流程、角色边界或下游研发实现。 -3. 修改背景复杂，直接改需求文档容易漏项或冲突。 - -流程： - -```text -来源聊天记录 / 上游文档 / 方法论 / 实验结论 / 案例结论 --> 写入产品总纲，记录背景、目标、边界和结论等级 --> 写产品方案文档，说明修改背景、修改内容、影响范围、前后口径、风险和验收 --> 产品审核员审核产品方案 --> 审核通过后进入需求文档书写流程 --> 交付产品-开发交接审核（研发审核） --> 研发审核通过后进入开发流程 --> 开发完成后按产品回交验收流程验收 -``` - -### 3.2 产品少量修改流程 - -适用场景： - -1. 修改范围小，通常只影响一份或少量需求文档。 -2. 不改变整体架构、核心流程和模块边界。 -3. 直接改需求文档不会造成上下游分叉。 - -流程： - -```text -来源聊天记录 / 上游反馈 --> 写入产品总纲或产品执行日志，记录修改原因和边界 --> 直接修改对应需求文档 --> 执行需求文档书写流程中的一致性检查 --> 交付产品-开发交接审核（研发审核） --> 研发审核通过后进入开发流程 --> 开发完成后按产品回交验收流程验收 -``` - -少量修改不强制先写产品方案文档，但必须记录修改背景、修改范围和需求一致性检查结论。 - -### 3.3 第一版产品交付流程 - -如果第一版产品需求包含大量模块、复杂流程或多个下游实现对象，必须先产出三大产品文档： - -1. 架构文档：说明整体结构、模块关系、上下游边界。 -2. 模块说明文档：说明每个模块的功能、职责、输入输出、边界。 -3. 核心流程文档：说明主流程、关键分支、异常路径和交付链路。 - -流程： - -```text -来源聊天记录 / 产品想法 / 方法论 / 上游结论 --> 写入产品总纲，记录第一版产品目标、背景和边界 --> 写架构文档、模块说明文档、核心流程文档 --> 产品审核员审核三大文档 --> 审核通过后进入需求文档书写流程 --> 交付产品-开发交接审核（研发审核） --> 研发审核通过后进入开发流程 --> 开发完成后按产品回交验收流程验收 -``` - -如果第一版产品需求很小，只涉及单一工具、单一文档或单一规则，可以不写三大文档，直接进入需求文档书写流程。 - -### 3.4 需求文档书写流程 - -无论是新写需求文档还是修改需求文档，写完后必须做一致性检查。 - -一致性检查必须参考： - -1. 架构文档、模块说明文档、核心流程文档：有就参考，没有就说明“不适用”。 -2. 产品方案文档：有就参考，没有就说明“不适用”。 -3. 产品总纲里的目标、背景、边界和关键聊天要求。 -4. 已有相关需求文档。 - -检查重点： - -1. 需求文档是否和产品方案一致。 -2. 需求文档是否和架构、模块说明、核心流程一致。 -3. 是否有冲突。 -4. 是否漏写必须实现的需求。 -5. 是否把未确认内容写成正式需求。 -6. 是否把小需求写成重型系统。 - -流程： - -```text -写需求文档 / 修改需求文档 --> 对照产品方案和三大文档做一致性检查 --> 记录一致性检查结论 --> 交付产品-开发交接审核（研发审核） --> 研发审核通过后进入开发流程 --> 开发完成后按产品回交验收流程验收 -``` - -### 3.5 产品-开发交接和回交验收流程 - -本节定义产品侧交接口径，不替代开发体系。 - -研发审核在产品体系里指“产品-开发交接审核”：开发侧接收前检查需求是否可实现、上游产品文档是否清楚、轻重流程判断是否合理、验收口径是否可执行。它不是新增重型 gate，也不替代开发体系里的方案审核和实现审计。 - -交付开发前，产品侧必须给开发侧提供： - -1. 产品总纲事项 ID。 -2. 需求文档。 -3. 如有产品方案文档，必须提供。 -4. 如有架构文档、模块说明文档、核心流程文档，必须提供。 -5. 产品审核或需求审核结论。 -6. 产品侧验收口径。 - -开发侧如果发现需求不清、产品文档冲突、无法实现、轻重判断不合理或验收口径不可执行，应记录为产品/需求问题并退回产品体系，不得靠代码猜。 - -开发完成后，开发侧回交给产品侧的材料至少包括： - -1. 代码变更说明。 -2. 运行入口或使用方式。 -3. 自测 / 测试结果。 -4. 开发审计结论。 -5. 需求-代码一致性自检结论。 -6. 已知限制和未解决问题。 - -产品验收记录写入 `产品审计报告.md`，结论回写产品总纲或产品执行日志。产品验收只判断交付行为是否满足产品目标、需求文档和上游产品文档，不替代开发审计。 - -## 3A. 通用产品事项证据链 - -不管走哪条分流，都必须保留证据链： - -```text -来源聊天记录 / 上游文档 / 方法论 / 实验结论 / 案例结论 --> 产品总纲记录背景、目标、边界和状态 --> 产品设计或产品方案 / 三大文档记录方案 --> 产品审核记录关键审核结论 --> 需求文档记录实现口径 --> 产品-开发交接记录 / 开发事项入口 --> 开发交付证据 --> 产品验收记录 --> 产品执行日志记录关键节点、产物路径和偏离 --> 产品产物审核 --> 问题修复 / 复审 --> 结论回写产品总纲和产品设计 --> 进入开发 / 实验 / 案例分析 / 暂缓 -``` - -## 4. 产品事项类型 - -| 类型 | 说明 | 典型产物 | -|---|---|---| -| 产品草案 | 初步想法、策略草稿、业务口径整理 | 草案说明、待确认项 | -| 轻量需求 | 小工具、单一文档、辅助脚本需求 | 轻量需求文档 | -| 正式需求 | 多模块、长流程、正式数据链路需求 | 正式需求文档 | -| 策略说明 | 交易/业务/方法论策略口径 | 策略说明文档 | -| 规则说明 | 可被实验、案例或开发消费的规则 | 规则表、规则说明 | - -## 5. 核心文档 - -### 5.1 产品总纲.md - -记录产品事项背景、来源聊天、目标、边界、状态和结论。 - -### 5.2 产品设计.md - -记录产品方案、需求拆解、输入输出、流程、验收方式和消费方。 - -产品设计不是代码设计。进入开发后，重型开发仍要按开发体系写编码方案。 - -### 5.3 产品方案文档 - -大量修改时使用，说明修改背景、修改内容、影响范围、前后口径、风险、验收和需求文档改写清单。 - -产品方案文档必须先经过产品审核员审核，通过后才能进入需求文档书写流程。 - -### 5.4 架构文档 - -第一版产品交付且模块较多时使用，说明产品整体结构、模块关系、上下游边界和主要数据/事项流。 - -### 5.5 模块说明文档 - -第一版产品交付且模块较多时使用，说明每个模块的大概功能、职责、输入输出、边界和消费方。 - -模块说明文档不是代码级设计，不要求写到类、函数或实现细节。 - -### 5.6 核心流程文档 - -第一版产品交付且流程较复杂时使用，说明主流程、关键分支、异常路径、下游交接和产品验收链路。 - -### 5.7 产品执行日志.md - -记录产品事项实际执行过程，包括关键判断、产物路径、偏离、当前状态和自检。 - -### 5.8 产品审计报告.md - -记录产品设计审核、产物审核和复审结论。 - -产品审核员发现的问题主记录写在产品审计报告；非审计来源问题写入产品问题记录。 - -### 5.9 产品问题记录.md - -记录非审计来源产品问题、影响、修复建议和复验状态。 - -### 5.10 需求规范.md - -约束正式需求文档的写法、边界和审核方式。产品体系产出需求文档时必须遵守。 - -## 6. 与其他体系的关系 - -| 下游体系 | 触发条件 | 交接方式 | -|---|---|---| -| 开发体系 | 产品产物需要代码实现 | 产品审计通过后，在开发体系创建开发事项 | -| 实验体系 | 产品规则需要数据验证 | 产品审计通过后，在实验体系创建实验事项 | -| 案例分析体系 | 产品规则需要逐案分析 | 产品审计通过后，在案例分析体系创建案例事项 | -| 项目体系 | 产品事项影响项目目标、边界、角色或体系启用 | 同步项目事项和项目变更 | - -## 7. 审核边界 - -产品审核重点看： - -1. 目标是否清楚。 -2. 是否对齐来源聊天和上游文档。 -3. 方案是否能满足目标。 -4. 输入、输出、消费方是否清楚。 -5. 边界和不做事项是否清楚。 -6. 验收方式是否够用但不过重。 -7. 是否适合进入开发、实验、案例分析或暂缓。 - -不应把非关键措辞、变量命名、格式偏好当作阻断问题。 - -## 8. 完成标准 - -产品事项完成必须按流程类型判断，不得把轻量事项强行套进重型产品设计审核。 - -通用完成标准： - -1. 产品总纲有来源、目标、边界和结论。 -2. 产品执行日志记录关键节点、产物路径、偏离和自检。 -3. 如有问题，已修复并复审。 -4. 如进入开发，必须完成产品-开发交接，并在开发回交后完成产品验收。 - -分流完成标准： - -| 流程类型 | 必须满足 | -|---|---| -| 产品大量修改 | 产品方案文档审核通过；需求文档完成一致性检查；如进入开发，产品验收通过 | -| 产品少量修改 | 需求文档审核通过；修改背景、范围和一致性检查已记录；不强制产品方案或产品设计审核 | -| 第一版复杂产品 | 架构文档、模块说明文档、核心流程文档审核通过；需求文档完成一致性检查；如进入开发，产品验收通过 | -| 第一版轻量产品 | 需求文档审核通过；目标、边界、验收口径清楚；不强制三大文档或产品设计审核 | - -## 9. 禁止事项 - -禁止： - -1. 未记录来源聊天就创建正式需求。 -2. 未审核通过就交给开发。 -3. 把产品草案当正式需求。 -4. 把实验结论或案例结论未经产品整理直接变成开发需求。 -5. 为了严谨把小需求写成重型系统。 -6. 用产品设计替代编码方案。 - -## 10. 一句话 - -产品体系负责把想法、方法论、实验/案例结论整理成清楚、可审计、可交接的产品或需求产物；它不替代开发、实验和案例分析。 diff --git "a/common/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/common/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" index 6c11dde..570d119 100644 --- "a/common/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" +++ "b/common/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -1,56 +1,55 @@ -# pro-doc 目录导读 +# pro-doc 目录导读 创建人员：Codex -文件职责：说明 `common/pro-doc` 目录下产品体系规范、创建指南、模板和需求写作规范的用途。 -管理规范/模板：../../全局规范.md；../../体系说明.md；产品规范.md。 -引用文件：产品规范.md；产品环境创建指南.md；产品审核规范.md；需求规范.md；本目录下全部 `*模版.md` 和 `*范本.md` 文件。 +文件职责：说明 `common/pro-doc` 目录下需求体系规范、创建指南、模板和需求写作规范的用途。 +管理规范/模板：../../全局规范.md；../../体系说明.md；需求规范.md。 +引用文件：需求规范.md；需求环境创建指南.md；需求审核规范.md；本目录下全部 `*模版.md` 和 `*范本.md` 文件。 记录方式：目录入口文档；新增或删除本目录正式文档时同步更新。 ## 1. 目录定位 -本目录保存通用产品体系文档。 +本目录保存通用需求体系文档。 -产品体系负责管理产品、需求、策略、业务规则、方法论转需求等事项。它回答： +需求体系负责管理需求、策略、业务规则、方法论转需求等事项。它回答： -1. 产品事项为什么出现。 -2. 产品目标和边界是什么。 -3. 产品方案或需求怎么设计。 +1. 需求事项为什么出现。 +2. 需求目标和边界是什么。 +3. 需求方案或需求怎么设计。 4. 设计是否经过审核。 -5. 产品产物是否能交给开发、实验、案例分析或项目管理继续消费。 -6. 非审计来源产品问题如何闭环。 +5. 需求产物是否能交给开发、实验、案例分析或项目管理继续消费。 +6. 非审计来源需求问题如何闭环。 -产品体系不写代码，不跑实验，不替代案例分析。需要代码时进入开发体系的产品开发工作区；需要验证时进入实验体系；需要逐案分析时进入案例分析体系。 +需求体系不写代码，不跑实验，不替代案例分析。需要代码时进入开发体系的需求开发工作区；需要验证时进入实验体系；需要逐案分析时进入案例分析体系。 ## 2. 文件清单 | 文件 | 类型 | 作用 | |---|---|---| -| 产品规范.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 | 范本 | 第一版复杂需求交付时参考，说明主流程、分支和交付链路 | +| 需求执行日志模版.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` 编写，并进入产品审核。 +2. 再读 `需求规范.md`。 +3. 按 `需求环境创建指南.md` 在项目中创建 `pro-doc/`。 +4. 本地 `需求规范.md`、`需求审核规范.md` 用 `需求环境创建指南.md` 的短引用模板创建，不复制 common 正文。 +5. 用模板创建本地 `需求总纲.md`、`需求设计.md`、`需求执行日志.md`、`需求审计报告.md`、`需求问题记录.md`。 +6. 大量修改时参考 `需求方案文档范本.md` 写需求方案，并先过需求审核。 +7. 第一版复杂需求交付时参考 `需求架构文档范本.md`、`需求模块说明文档范本.md`、`需求核心流程文档范本.md` 写三大文档，并先过需求审核。 +8. 如要产出正式需求文档，按 `需求规范.md` 和 `需求文档范本.md` 编写，并进入需求审核。 -项目内产品文档默认 append-only 维护：最新产品事项、设计、执行、审计、问题追加到对应文件末尾。 +项目内需求文档默认 append-only 维护：最新需求事项、设计、执行、审计、问题追加到对应文件末尾。 diff --git "a/common/pro-doc/\344\272\247\345\223\201\345\256\241\346\240\270\350\247\204\350\214\203.md" "b/common/pro-doc/\351\234\200\346\261\202\345\256\241\346\240\270\350\247\204\350\214\203.md" similarity index 69% rename from "common/pro-doc/\344\272\247\345\223\201\345\256\241\346\240\270\350\247\204\350\214\203.md" rename to "common/pro-doc/\351\234\200\346\261\202\345\256\241\346\240\270\350\247\204\350\214\203.md" index d61ef69..938a1cf 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\345\256\241\346\240\270\350\247\204\350\214\203.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\345\256\241\346\240\270\350\247\204\350\214\203.md" @@ -1,14 +1,14 @@ -# 产品审核规范 +# 需求审核规范 创建人员：Codex -文件职责：定义产品体系的设计审核、产物审核、复审、阻断标准和审核员权限边界。 -管理规范/模板：../../全局规范.md；产品规范.md；需求规范.md。 -引用文件：产品规范.md；需求规范.md；产品审计报告模版.md；产品问题记录模版.md。 -记录方式：全局产品审核规范；审核口径变化时更新。 +文件职责：定义需求体系的设计审核、产物审核、复审、阻断标准和审核员权限边界。 +管理规范/模板：../../全局规范.md；需求规范.md；需求审核规范.md。 +引用文件：需求规范.md；需求审计报告模版.md；需求问题记录模版.md。 +记录方式：全局需求审核规范；审核口径变化时更新。 ## 1. 审核目标 -产品审核的目标是判断产品事项是否目标清楚、设计合理、证据链完整、产物可交接。 +需求审核的目标是判断需求事项是否目标清楚、设计合理、证据链完整、产物可交接。 审核员不应为了形式完美而层层加码。只阻断会影响目标、边界、实现、验证或结论的问题。 @@ -18,18 +18,18 @@ 必须检查： -1. 来源聊天记录或上游依据是否写入产品总纲。 -2. 产品目标是否清楚。 -3. 产品设计是否能满足目标。 +1. 来源聊天记录或上游依据是否写入需求总纲。 +2. 需求目标是否清楚。 +3. 需求设计是否能满足目标。 4. 输入、输出、消费方是否清楚。 5. 边界和不做事项是否清楚。 6. 验收方式是否合理。 7. 如果要进入开发，需求是否符合 `需求规范.md`。 8. 如果要进入实验或案例分析，是否写清要验证什么。 -### 2.1 产品方案审核 +### 2.1 需求方案审核 -大量产品修改时，产品审核员必须先审核产品方案文档。 +大量需求修改时，需求审核员必须先审核需求方案文档。 检查重点： @@ -40,11 +40,11 @@ 5. 是否有需求文档改写清单。 6. 是否存在直接改需求会漏项或冲突的风险。 -产品方案审核通过后，才能进入需求文档书写流程。 +需求方案审核通过后，才能进入需求文档书写流程。 ### 2.2 三大文档审核 -第一版复杂产品交付时，产品审核员必须审核： +第一版复杂需求交付时，需求审核员必须审核： 1. 架构文档。 2. 模块说明文档。 @@ -62,19 +62,19 @@ ## 3. 产物审核 -产物审核发生在产品文档、需求文档、策略说明或规则说明完成后。 +产物审核发生在需求文档、策略说明或规则说明完成后。 必须检查： 1. 产物是否按设计完成。 -2. 产物路径是否写入产品执行日志。 +2. 产物路径是否写入需求执行日志。 3. 产物是否能被下游理解。 4. 结论等级是否清楚。 5. 是否存在和来源聊天要求不一致的地方。 6. 是否存在会导致下游走两条路线的模糊点。 -7. 如果是需求文档，是否已对照产品方案或三大文档做一致性检查。 -8. 如果存在产品方案或三大文档，需求是否漏写必须实现的内容。 -9. 如果不存在产品方案或三大文档，是否说明不适用且理由合理。 +7. 如果是需求文档，是否已对照需求方案或三大文档做一致性检查。 +8. 如果存在需求方案或三大文档，需求是否漏写必须实现的内容。 +9. 如果不存在需求方案或三大文档，是否说明不适用且理由合理。 ## 4. 阻断问题 @@ -100,9 +100,9 @@ ## 6. 审计记录 -产品审核员发现的问题主记录写入 `产品审计报告.md`。 +需求审核员发现的问题主记录写入 `需求审计报告.md`。 -非审计人员发现的问题写入 `产品问题记录.md`。 +非审计人员发现的问题写入 `需求问题记录.md`。 如果问题需要长期跟踪，可以在问题记录中建立索引，但不能替代审计报告的主记录。 diff --git "a/common/pro-doc/\344\272\247\345\223\201\345\256\241\350\256\241\346\212\245\345\221\212\346\250\241\347\211\210.md" "b/common/pro-doc/\351\234\200\346\261\202\345\256\241\350\256\241\346\212\245\345\221\212\346\250\241\347\211\210.md" similarity index 81% rename from "common/pro-doc/\344\272\247\345\223\201\345\256\241\350\256\241\346\212\245\345\221\212\346\250\241\347\211\210.md" rename to "common/pro-doc/\351\234\200\346\261\202\345\256\241\350\256\241\346\212\245\345\221\212\346\250\241\347\211\210.md" index 2ad2433..810b8e0 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\345\256\241\350\256\241\346\212\245\345\221\212\346\250\241\347\211\210.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\345\256\241\350\256\241\346\212\245\345\221\212\346\250\241\347\211\210.md" @@ -1,16 +1,16 @@ -# 产品审计报告 +# 需求审计报告 创建人员：<创建人员> -文件职责：记录产品设计审核、产品产物审核、需求口径审核、复审结论和审计问题主记录。 -管理规范/模板：../../common/pro-doc/产品审核规范.md；../../common/pro-doc/产品审计报告模版.md。 -引用文件：产品规范.md；产品总纲.md；产品设计.md；产品执行日志.md；产品问题记录.md；需求规范.md。 +文件职责：记录需求设计审核、需求产物审核、需求口径审核、复审结论和审计问题主记录。 +管理规范/模板：../../common/pro-doc/需求审核规范.md；../../common/pro-doc/需求审计报告模版.md。 +引用文件：需求规范.md；需求总纲.md；需求设计.md；需求执行日志.md；需求问题记录.md；需求规范.md。 记录方式：append-only；每次审核和复审追加记录，审计问题主记录写在本文件。 ## 1. 文档作用 本文件用于记录审核员的正式结论。 -审核员发现的问题，主记录写在本文件；只有需要跨轮跟踪或非审计来源问题汇总时，才在 `产品问题记录.md` 建索引。 +审核员发现的问题，主记录写在本文件；只有需要跨轮跟踪或非审计来源问题汇总时，才在 `需求问题记录.md` 建索引。 ## 2. 审计索引 @@ -25,8 +25,8 @@ 审计时间：<YYYY-MM-DD HH:mm:ss> 审核人：<AI 或人员> 审计类型：设计审核 / 产物审核 / 需求审核 / 复审 -审计对象：<产品事项 ID / 设计 ID / 文档路径> -关联产品事项：<PRO-001> +审计对象：<需求事项 ID / 设计 ID / 文档路径> +关联需求事项：<PRO-001> 关联设计：<DESIGN-ID> 结论：通过 / 驳回 / 有条件通过 @@ -43,7 +43,7 @@ #### 3.2 目标和聊天要求对齐 -产品总纲目标是否清楚：是 / 否 +需求总纲目标是否清楚：是 / 否 设计是否覆盖目标：是 / 否 关键聊天要求是否写入背景或被引用：是 / 否 / 不适用 diff --git "a/common/pro-doc/\344\272\247\345\223\201\346\200\273\347\272\262\346\250\241\347\211\210.md" "b/common/pro-doc/\351\234\200\346\261\202\346\200\273\347\272\262\346\250\241\347\211\210.md" similarity index 69% rename from "common/pro-doc/\344\272\247\345\223\201\346\200\273\347\272\262\346\250\241\347\211\210.md" rename to "common/pro-doc/\351\234\200\346\261\202\346\200\273\347\272\262\346\250\241\347\211\210.md" index 405c47c..b6ad3d7 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\346\200\273\347\272\262\346\250\241\347\211\210.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\200\273\347\272\262\346\250\241\347\211\210.md" @@ -1,35 +1,35 @@ -# 产品总纲 +# 需求总纲 创建人员：<创建人员> -文件职责：记录本项目所有产品事项、需求事项、策略事项和业务规则事项的背景、目标、边界、状态和结论，是产品体系的事项总账。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品总纲模版.md。 -引用文件：产品规范.md；产品设计.md；产品执行日志.md；产品审计报告.md；产品问题记录.md；需求规范.md。 -记录方式：append-only；新增产品事项、目标变化、结论变化时追加记录，最新记录放在文档末尾，不静默覆盖历史。 +文件职责：记录本项目所有需求事项、需求事项、策略事项和业务规则事项的背景、目标、边界、状态和结论，是需求体系的事项总账。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求总纲模版.md。 +引用文件：需求规范.md；需求设计.md；需求执行日志.md；需求审计报告.md；需求问题记录.md；需求规范.md。 +记录方式：append-only；新增需求事项、目标变化、结论变化时追加记录，最新记录放在文档末尾，不静默覆盖历史。 ## 1. 文档作用 本文件用于让人或 AI 快速知道： -1. 当前有哪些产品事项。 +1. 当前有哪些需求事项。 2. 每个事项为什么出现。 3. 每个事项要解决什么问题。 4. 每个事项的边界是什么。 5. 每个事项当前状态是什么。 6. 每个事项对应的设计、执行日志、审计和产物在哪里。 -## 2. 产品事项索引 +## 2. 需求事项索引 -| 产品事项 ID | 名称 | 类型 | 来源 | 当前状态 | 设计 ID | 审计 ID | 最新结论 | +| 需求事项 ID | 名称 | 类型 | 来源 | 当前状态 | 设计 ID | 审计 ID | 最新结论 | |---|---|---|---|---|---|---|---| -| <PRO-001> | <事项名称> | 需求 / 产品 / 策略 / 业务规则 / 方法论转需求 | <聊天 / 上游文档 / 人工反馈> | 设计中 / 待审 / 执行中 / 已通过 / 暂停 / 取消 | <DESIGN-ID> | <AUDIT-ID> | <一句话结论> | +| <PRO-001> | <事项名称> | 需求 / 需求 / 策略 / 业务规则 / 方法论转需求 | <聊天 / 上游文档 / 人工反馈> | 设计中 / 待审 / 执行中 / 已通过 / 暂停 / 取消 | <DESIGN-ID> | <AUDIT-ID> | <一句话结论> | -## 3. 产品事项记录模板 +## 3. 需求事项记录模板 ### <PRO-001> <事项名称> 记录时间：<YYYY-MM-DD HH:mm:ss> 记录人：<AI 或人员> -事项类型：需求 / 产品 / 策略 / 业务规则 / 方法论转需求 +事项类型：需求 / 需求 / 策略 / 业务规则 / 方法论转需求 当前状态：设计中 / 待审 / 执行中 / 已通过 / 暂停 / 取消 #### 3.1 来源和背景 @@ -39,13 +39,13 @@ 关键聊天要求： ```text -<必须记录会影响产品目标、边界、验收的关键聊天要求。> +<必须记录会影响需求目标、边界、验收的关键聊天要求。> ``` 背景说明： ```text -<为什么要做这个产品事项，当前痛点是什么。> +<为什么要做这个需求事项，当前痛点是什么。> ``` #### 3.2 目标 @@ -89,7 +89,7 @@ | 文档类型 | 路径或 ID | 说明 | |---|---|---| -| 产品设计 | <DESIGN-ID 或路径> | <说明> | +| 需求设计 | <DESIGN-ID 或路径> | <说明> | | 执行日志 | <LOG-ID 或路径> | <说明> | | 审计报告 | <AUDIT-ID 或路径> | <说明> | | 需求文档 | <路径> | <如有> | diff --git "a/common/pro-doc/\344\272\247\345\223\201\346\211\247\350\241\214\346\227\245\345\277\227\346\250\241\347\211\210.md" "b/common/pro-doc/\351\234\200\346\261\202\346\211\247\350\241\214\346\227\245\345\277\227\346\250\241\347\211\210.md" similarity index 79% rename from "common/pro-doc/\344\272\247\345\223\201\346\211\247\350\241\214\346\227\245\345\277\227\346\250\241\347\211\210.md" rename to "common/pro-doc/\351\234\200\346\261\202\346\211\247\350\241\214\346\227\245\345\277\227\346\250\241\347\211\210.md" index 5f3db08..27b1129 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\346\211\247\350\241\214\346\227\245\345\277\227\346\250\241\347\211\210.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\211\247\350\241\214\346\227\245\345\277\227\346\250\241\347\211\210.md" @@ -1,17 +1,17 @@ -# 产品执行日志 +# 需求执行日志 创建人员：<创建人员> -文件职责：记录产品事项执行过程中的关键节点、数据来源、文档产物、决策变化、自检和交接记录。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品执行日志模版.md。 -引用文件：产品总纲.md；产品设计.md；产品审计报告.md；产品问题记录.md。 +文件职责：记录需求事项执行过程中的关键节点、数据来源、文档产物、决策变化、自检和交接记录。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求执行日志模版.md。 +引用文件：需求总纲.md；需求设计.md；需求审计报告.md；需求问题记录.md。 记录方式：append-only；每次执行、修改、回写、交接都追加日志，最新记录放在文档末尾。 ## 1. 文档作用 本文件用于让审核员和后续 AI 追踪： -1. 产品事项实际做了什么。 -2. 是否按产品设计执行。 +1. 需求事项实际做了什么。 +2. 是否按需求设计执行。 3. 中间材料和最终产物在哪里。 4. 有没有偏离设计。 5. 自检结果是什么。 @@ -19,7 +19,7 @@ ## 2. 执行日志索引 -| 日志 ID | 产品事项 ID | 设计 ID | 时间 | 执行人 | 动作 | 产物 | 状态 | +| 日志 ID | 需求事项 ID | 设计 ID | 时间 | 执行人 | 动作 | 产物 | 状态 | |---|---|---|---|---|---|---|---| | <LOG-PRO-001-001> | <PRO-001> | <DESIGN-ID> | <YYYY-MM-DD HH:mm:ss> | <执行人> | <动作摘要> | <路径> | 完成 / 失败 / 待补 | @@ -29,7 +29,7 @@ 时间：<YYYY-MM-DD HH:mm:ss> 执行人：<AI 或人员> -关联产品事项：<PRO-001> +关联需求事项：<PRO-001> 关联设计：<DESIGN-ID> 当前状态：完成 / 失败 / 待补 @@ -87,7 +87,7 @@ 自检项： -1. 产品目标是否仍然对齐：通过 / 不通过 / 不适用。 +1. 需求目标是否仍然对齐：通过 / 不通过 / 不适用。 2. 文档引用是否可追踪：通过 / 不通过 / 不适用。 3. 关键聊天要求是否已写入背景或引用：通过 / 不通过 / 不适用。 4. 下游交接边界是否清楚：通过 / 不通过 / 不适用。 diff --git "a/common/pro-doc/\351\234\200\346\261\202\346\226\207\346\241\243\350\214\203\346\234\254.md" "b/common/pro-doc/\351\234\200\346\261\202\346\226\207\346\241\243\350\214\203\346\234\254.md" index 265687a..61b6e4b 100644 --- "a/common/pro-doc/\351\234\200\346\261\202\346\226\207\346\241\243\350\214\203\346\234\254.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\226\207\346\241\243\350\214\203\346\234\254.md" @@ -1,9 +1,9 @@ -# 需求文档范本 +# 需求文档范本 创建人员：<创建人员> -文件职责：提供正式需求文档的通用结构范本，帮助产品 AI 写出可实现、可审核、不过度加码的需求文档。 +文件职责：提供正式需求文档的通用结构范本，帮助需求 AI 写出可实现、可审核、不过度加码的需求文档。 管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求文档范本.md。 -引用文件：产品规范.md；产品设计.md；产品审计报告.md；../../common/dev-doc/编码规范.md。 +引用文件：需求规范.md；需求设计.md；需求审计报告.md；../../common/dev-doc/编码规范.md。 记录方式：范本文档；需求文档结构变化时更新，具体项目复制后按项目内容填写。 ## 1. 文档目标 @@ -16,7 +16,7 @@ ## 2. 背景和来源 -来源类型：聊天记录 / 产品设计 / 实验结论 / 案例分析结论 / 人工反馈 / 其他 +来源类型：聊天记录 / 需求设计 / 实验结论 / 案例分析结论 / 人工反馈 / 其他 来源位置：<相对路径或聊天摘要> 关键聊天要求： @@ -41,28 +41,28 @@ 1. <明确不做事项> -## 3A. 产品上游一致性检查 +## 3A. 需求上游一致性检查 -上游产品文档： +上游需求文档： | 文档 | 是否存在 | 路径 | 检查结论 | |---|---|---|---| -| 产品方案文档 | 是 / 否 / 不适用 | <路径> | <一致 / 有冲突 / 待补> | +| 需求方案文档 | 是 / 否 / 不适用 | <路径> | <一致 / 有冲突 / 待补> | | 架构文档 | 是 / 否 / 不适用 | <路径> | <一致 / 有冲突 / 待补> | | 模块说明文档 | 是 / 否 / 不适用 | <路径> | <一致 / 有冲突 / 待补> | | 核心流程文档 | 是 / 否 / 不适用 | <路径> | <一致 / 有冲突 / 待补> | -| 产品总纲 | 是 / 否 | <路径> | <一致 / 有冲突 / 待补> | +| 需求总纲 | 是 / 否 | <路径> | <一致 / 有冲突 / 待补> | 一致性结论： ```text -<需求是否和产品方案、三大文档、产品总纲一致；是否有冲突；是否有漏写。> +<需求是否和需求方案、三大文档、需求总纲一致；是否有冲突；是否有漏写。> ``` 如果上游文档不存在，说明原因： ```text -<例如：本需求是少量修改，不需要产品方案；本产品是轻量首版交付，不需要三大文档。> +<例如：本需求是少量修改，不需要需求方案；本需求是轻量首版交付，不需要三大文档。> ``` ## 4. 模块职责 diff --git "a/common/pro-doc/\344\272\247\345\223\201\346\226\271\346\241\210\346\226\207\346\241\243\350\214\203\346\234\254.md" "b/common/pro-doc/\351\234\200\346\261\202\346\226\271\346\241\210\346\226\207\346\241\243\350\214\203\346\234\254.md" similarity index 79% rename from "common/pro-doc/\344\272\247\345\223\201\346\226\271\346\241\210\346\226\207\346\241\243\350\214\203\346\234\254.md" rename to "common/pro-doc/\351\234\200\346\261\202\346\226\271\346\241\210\346\226\207\346\241\243\350\214\203\346\234\254.md" index 75e4a7f..24e5097 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\346\226\271\346\241\210\346\226\207\346\241\243\350\214\203\346\234\254.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\226\271\346\241\210\346\226\207\346\241\243\350\214\203\346\234\254.md" @@ -1,14 +1,14 @@ -# 产品方案文档范本 +# 需求方案文档范本 创建人员：<创建人员> -文件职责：提供产品大量修改时的方案文档结构，用于在改需求文档前说清修改背景、修改内容、影响范围和验收口径。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品方案文档范本.md。 -引用文件：产品总纲.md；产品设计.md；产品审计报告.md；需求规范.md；需求文档范本.md。 -记录方式：范本文档；具体项目复制后按产品事项填写，方案审核通过后才能进入需求文档书写流程。 +文件职责：提供需求大量修改时的方案文档结构，用于在改需求文档前说清修改背景、修改内容、影响范围和验收口径。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求方案文档范本.md。 +引用文件：需求总纲.md；需求设计.md；需求审计报告.md；需求规范.md；需求文档范本.md。 +记录方式：范本文档；具体项目复制后按需求事项填写，方案审核通过后才能进入需求文档书写流程。 ## 1. 方案目标 -产品事项 ID：<PRO-ID> +需求事项 ID：<PRO-ID> 方案 ID：<SOLUTION-ID> 方案名称：<名称> 方案状态：草案 / 待审 / 通过 / 驳回 / 暂缓 @@ -28,7 +28,7 @@ 关键背景： ```text -<为什么要改；旧产品哪里不够；如果不改有什么影响。> +<为什么要改；旧需求哪里不够；如果不改有什么影响。> ``` ## 3. 修改范围 @@ -69,7 +69,7 @@ ## 5. 影响评估 -对产品文档的影响： +对需求文档的影响： 1. <影响> @@ -93,9 +93,9 @@ ## 7. 验收口径 -产品验收： +需求验收： -1. <产品验收项> +1. <需求验收项> 需求一致性验收： diff --git "a/common/pro-doc/\344\272\247\345\223\201\346\236\266\346\236\204\346\226\207\346\241\243\350\214\203\346\234\254.md" "b/common/pro-doc/\351\234\200\346\261\202\346\236\266\346\236\204\346\226\207\346\241\243\350\214\203\346\234\254.md" similarity index 80% rename from "common/pro-doc/\344\272\247\345\223\201\346\236\266\346\236\204\346\226\207\346\241\243\350\214\203\346\234\254.md" rename to "common/pro-doc/\351\234\200\346\261\202\346\236\266\346\236\204\346\226\207\346\241\243\350\214\203\346\234\254.md" index f1ebe18..75a7170 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\346\236\266\346\236\204\346\226\207\346\241\243\350\214\203\346\234\254.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\236\266\346\236\204\346\226\207\346\241\243\350\214\203\346\234\254.md" @@ -1,10 +1,10 @@ -# 产品架构文档范本 +# 需求架构文档范本 创建人员：<创建人员> -文件职责：提供复杂产品第一版交付时可参考的架构文档写法，说明整体结构、模块关系、公共能力、唯一归属和工程化范围。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品架构文档范本.md。 -引用文件：产品总纲.md；产品设计.md；产品模块说明文档范本.md；产品核心流程文档范本.md；产品审计报告.md。 -记录方式：参考范本；不是逐项填空模板。具体项目可按产品复杂度裁剪，但不得漏掉会影响架构理解的关键内容。 +文件职责：提供复杂需求第一版交付时可参考的架构文档写法，说明整体结构、模块关系、公共能力、唯一归属和工程化范围。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求架构文档范本.md。 +引用文件：需求总纲.md；需求设计.md；需求模块说明文档范本.md；需求核心流程文档范本.md；需求审计报告.md。 +记录方式：参考范本；不是逐项填空模板。具体项目可按需求复杂度裁剪，但不得漏掉会影响架构理解的关键内容。 ## 1. 使用口径 @@ -12,9 +12,9 @@ 适用场景： -1. 第一版产品模块较多。 -2. 产品有多个上下游。 -3. 产品包含公共能力、业务模块、归档或审核链路。 +1. 第一版需求模块较多。 +2. 需求有多个上下游。 +3. 需求包含公共能力、业务模块、归档或审核链路。 4. 不先讲清架构，后续需求文档容易拆乱。 不适用场景： @@ -44,7 +44,7 @@ 推荐写法： ```text -本文档回答：<产品名> 由哪几个模块组成，各模块主责是什么，哪些公共能力必须集中实现，哪些业务不能拆散到多个模块里。 +本文档回答：<需求名> 由哪几个模块组成，各模块主责是什么，哪些公共能力必须集中实现，哪些业务不能拆散到多个模块里。 本文档不是字段级需求，也不是代码设计。字段、CLI、表结构和验收细节以需求文档为准。 ``` @@ -56,7 +56,7 @@ 1. 模块说明文档。 2. 核心流程文档。 3. 需求文档。 -4. 方法论 / 产品方案 / 总纲。 +4. 方法论 / 需求方案 / 总纲。 5. 审计报告。 ### 2.3 一句话架构 @@ -66,7 +66,7 @@ 推荐写法： ```text -<产品名> 当前只做一件事： +<需求名> 当前只做一件事： <一句话说明主目标> 当前不做： @@ -84,7 +84,7 @@ | P2 / 业务模块 B | <主责> | <一句话> | | P3 / 归档或验收模块 | <主责> | <一句话> | -模块编号不是强制的。简单产品可以不用 P0/P1/P2 命名，但必须让模块主责清楚。 +模块编号不是强制的。简单需求可以不用 P0/P1/P2 命名，但必须让模块主责清楚。 ### 2.5 总体架构图 @@ -146,7 +146,7 @@ ### 2.9 核心对象 -对产品里最容易混淆的对象做定义。 +对需求里最容易混淆的对象做定义。 ```text 对象 A：<定义> @@ -158,7 +158,7 @@ 通过标准： -1. 人能看懂产品由哪些模块组成。 +1. 人能看懂需求由哪些模块组成。 2. 人能看懂模块主责和边界。 3. 人能看懂公共能力在哪里集中。 4. 人能看懂哪些能力本轮不做。 diff --git "a/common/pro-doc/\344\272\247\345\223\201\346\240\270\345\277\203\346\265\201\347\250\213\346\226\207\346\241\243\350\214\203\346\234\254.md" "b/common/pro-doc/\351\234\200\346\261\202\346\240\270\345\277\203\346\265\201\347\250\213\346\226\207\346\241\243\350\214\203\346\234\254.md" similarity index 75% rename from "common/pro-doc/\344\272\247\345\223\201\346\240\270\345\277\203\346\265\201\347\250\213\346\226\207\346\241\243\350\214\203\346\234\254.md" rename to "common/pro-doc/\351\234\200\346\261\202\346\240\270\345\277\203\346\265\201\347\250\213\346\226\207\346\241\243\350\214\203\346\234\254.md" index bcff00c..5ecf7a2 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\346\240\270\345\277\203\346\265\201\347\250\213\346\226\207\346\241\243\350\214\203\346\234\254.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\240\270\345\277\203\346\265\201\347\250\213\346\226\207\346\241\243\350\214\203\346\234\254.md" @@ -1,17 +1,17 @@ -# 产品核心流程文档范本 +# 需求核心流程文档范本 创建人员：<创建人员> -文件职责：提供复杂产品第一版交付时可参考的核心流程文档写法，用于说明输入到输出的主流程、关键分支、阶段边界和不覆盖范围。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品核心流程文档范本.md。 -引用文件：产品总纲.md；产品设计.md；产品架构文档范本.md；产品模块说明文档范本.md；产品审计报告.md。 -记录方式：参考范本；不是逐项填空模板。具体项目可按产品复杂度裁剪，但必须保留主流程、关键分支、阶段边界和下游交接。 +文件职责：提供复杂需求第一版交付时可参考的核心流程文档写法，用于说明输入到输出的主流程、关键分支、阶段边界和不覆盖范围。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求核心流程文档范本.md。 +引用文件：需求总纲.md；需求设计.md；需求架构文档范本.md；需求模块说明文档范本.md；需求审计报告.md。 +记录方式：参考范本；不是逐项填空模板。具体项目可按需求复杂度裁剪，但必须保留主流程、关键分支、阶段边界和下游交接。 ## 1. 使用口径 核心流程文档回答： ```text -产品从输入到输出，中间按什么顺序流转。 +需求从输入到输出，中间按什么顺序流转。 ``` 它不回答： @@ -28,7 +28,7 @@ 推荐写法： ```text -本文档回答：<产品名> 从 <输入> 到 <输出> 中间按什么顺序流转。 +本文档回答：<需求名> 从 <输入> 到 <输出> 中间按什么顺序流转。 当前流程覆盖： <覆盖范围> @@ -43,7 +43,7 @@ 1. 架构文档。 2. 模块说明文档。 -3. 产品方案或产品总纲。 +3. 需求方案或需求总纲。 4. 模块需求文档。 5. 审计报告。 @@ -104,16 +104,16 @@ |---|---|---|---| | <条件> | <路径> | <输出> | 是 / 否 | -### 2.7 产品到需求到研发到验收链路 +### 2.7 需求到研发到验收链路 -产品核心流程文档应把交付链路写清楚： +需求核心流程文档应把交付链路写清楚： ```text -产品方案 / 三大文档 +需求方案 / 三大文档 -> 需求文档书写和一致性检查 -> 研发审核 -> 开发流程 --> 产品验收 +-> 需求验收 -> 结论回写 ``` @@ -143,5 +143,5 @@ 1. 只有模块列表，没有流转顺序。 2. 主流程和异常路径混在一起。 3. 没有说明不覆盖范围。 -4. 流程绕过了产品审核、研发审核或产品验收。 +4. 流程绕过了需求审核、研发审核或需求验收。 diff --git "a/common/pro-doc/\344\272\247\345\223\201\346\250\241\345\235\227\350\257\264\346\230\216\346\226\207\346\241\243\350\214\203\346\234\254.md" "b/common/pro-doc/\351\234\200\346\261\202\346\250\241\345\235\227\350\257\264\346\230\216\346\226\207\346\241\243\350\214\203\346\234\254.md" similarity index 84% rename from "common/pro-doc/\344\272\247\345\223\201\346\250\241\345\235\227\350\257\264\346\230\216\346\226\207\346\241\243\350\214\203\346\234\254.md" rename to "common/pro-doc/\351\234\200\346\261\202\346\250\241\345\235\227\350\257\264\346\230\216\346\226\207\346\241\243\350\214\203\346\234\254.md" index f2a3b11..41c22ea 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\346\250\241\345\235\227\350\257\264\346\230\216\346\226\207\346\241\243\350\214\203\346\234\254.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\346\250\241\345\235\227\350\257\264\346\230\216\346\226\207\346\241\243\350\214\203\346\234\254.md" @@ -1,10 +1,10 @@ -# 产品模块说明文档范本 +# 需求模块说明文档范本 创建人员：<创建人员> -文件职责：提供复杂产品第一版交付时可参考的模块说明写法，用于说明各模块的功能、作用、边界和上下游关系。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品模块说明文档范本.md。 -引用文件：产品总纲.md；产品设计.md；产品架构文档范本.md；产品核心流程文档范本.md；产品审计报告.md。 -记录方式：参考范本；不是逐项填空模板。具体项目可按产品复杂度裁剪，但必须保留模块功能、作用、边界和上下游关系。 +文件职责：提供复杂需求第一版交付时可参考的模块说明写法，用于说明各模块的功能、作用、边界和上下游关系。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求模块说明文档范本.md。 +引用文件：需求总纲.md；需求设计.md；需求架构文档范本.md；需求核心流程文档范本.md；需求审计报告.md。 +记录方式：参考范本；不是逐项填空模板。具体项目可按需求复杂度裁剪，但必须保留模块功能、作用、边界和上下游关系。 ## 1. 使用口径 @@ -27,17 +27,17 @@ 推荐写法： ```text -本文档只说明 <产品名> 各模块的功能、作用、边界和上下游关系。 +本文档只说明 <需求名> 各模块的功能、作用、边界和上下游关系。 本文档不写字段级合同、不写 CLI、不写具体表结构。实现细节以各模块需求文档为准。 ``` ### 2.2 一句话说明 -说明产品目标和当前不做事项。 +说明需求目标和当前不做事项。 ```text -<产品名> 的目标是： +<需求名> 的目标是： <一句话目标> 当前不做： diff --git "a/common/pro-doc/\351\234\200\346\261\202\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" "b/common/pro-doc/\351\234\200\346\261\202\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" new file mode 100644 index 0000000..186cb42 --- /dev/null +++ "b/common/pro-doc/\351\234\200\346\261\202\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" @@ -0,0 +1,190 @@ +# 需求环境创建指南 + +创建人员：Codex +文件职责：指导项目管理员在具体项目中创建需求体系环境、基础文档、审计入口和项目配置登记。 +管理规范/模板：../../全局规范.md；../../体系说明.md；需求规范.md。 +引用文件：需求规范.md；需求审核规范.md；需求总纲模版.md；需求设计模版.md；需求方案文档范本.md；需求架构文档范本.md；需求模块说明文档范本.md；需求核心流程文档范本.md；需求执行日志模版.md；需求审计报告模版.md；需求问题记录模版.md；需求文档范本.md。 +记录方式：创建指南；需求体系创建流程变化时更新。 + +## 1. 使用场景 + +项目管理员决定启用需求体系时，按本指南执行。 + +需求体系用于承接需求、策略、业务规则等文档工作。 + +## 2. 输入 + +创建前应明确： + +1. 项目名称和项目根目录。 +2. 需求体系是否启用。 +3. 需求 AI。 +4. 需求审核员。 +5. 是否需要立即创建第一个需求事项。 + +前置检查： + +1. 项目根目录应已有 `项目配置清单.md`、`项目执行日志.md`、`项目变更记录.md`。 +2. 如果项目级入口不存在，必须先按 `common/project-doc/项目环境创建指南.md` 初始化项目体系。 +3. 不允许绕过项目配置清单直接创建孤立的 `pro-doc/`。 + +## 3. 创建目录 + +默认创建： + +```text +pro-doc/ +pro-doc/tmp/ +``` + +说明： + +1. `pro-doc/` 存需求文档、策略说明、规则说明、总纲、设计、日志、审计和问题记录。 +2. `pro-doc/tmp/` 存临时草稿，不得作为正式产物入口。 + +## 4. 创建基础文档 + +在项目 `pro-doc/` 下创建： + +1. `目录导读.md` +2. `需求规范.md` +3. `需求审核规范.md` +4. `需求总纲.md` +5. `需求设计.md` +6. `需求执行日志.md` +7. `需求审计报告.md` +8. `需求问题记录.md` + +本地 `需求规范.md`、`需求审核规范.md` 默认只引用 common 对应规范，可以没有额外补充。 + +`需求方案文档范本.md`、`需求架构文档范本.md`、`需求模块说明文档范本.md`、`需求核心流程文档范本.md` 是 common 参考范本，不是项目初始化必须复制的本地文档。 + +只有在对应事项需要时才创建具体文档： + +1. 大量需求修改：创建具体 `需求方案-<事项ID>.md`。 +2. 第一版复杂需求交付：创建具体 `需求架构-<事项ID>.md`、`需求模块说明-<事项ID>.md`、`需求核心流程-<事项ID>.md`。 +3. 少量修改或轻量首版交付：不强制创建这些文档，直接进入需求文档书写流程。 + +不得把 common 规范全文复制到本地规范。创建本地规范时使用下面的短引用结构。 + +本地 `需求规范.md` 初始内容： + +```text +# 需求规范 + +创建人员：<创建人员> +文件职责：记录本项目需求体系必须遵守的本地规范。本文件引用 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` 初始内容： + +```text +# 需求审核规范 + +创建人员：<创建人员> +文件职责：记录本项目需求审核员必须遵守的本地审核规范。本文件引用 common/pro-doc/需求审核规范.md，不得削弱 common 需求审核规范硬约束。 +管理规范/模板：../../common/pro-doc/需求审核规范.md +引用文件：需求规范.md；需求审计报告.md；需求问题记录.md +记录方式：本地审核规范；如有项目特化审核流程或补充规则，追加到本文件。 + +## 1. 基本口径 + +本项目所有需求审核员必须同时遵守 ../../common/pro-doc/需求审核规范.md 和本文件。 + +本文件当前没有额外补充规则。如后续设计本地需求审核流程，必须满足 common 需求审核规范硬约束；流程通过审核后，执行时以本地流程为准。 +``` + +## 5. 更新项目配置清单 + +在项目根目录 `项目配置清单.md` 中更新： + +1. 需求体系启用状态为“是”。 +2. 目录为 `pro-doc/`。 +3. common 规范为 `../common/pro-doc/需求规范.md`、`../common/pro-doc/需求审核规范.md`。 +4. 本地规范为 `pro-doc/需求规范.md`、`pro-doc/需求审核规范.md`。 +5. 需求 AI 和需求审核员。 + +同时在项目执行日志和项目变更记录中登记启用动作。 + +## 6. 体系创建校验方案 + +需求体系创建完成后，项目管理员或需求审核员应做一次轻量校验。 + +### 6.1 目录和文档校验 + +检查： + +1. `pro-doc/`、`pro-doc/tmp/` 存在。 +2. `目录导读.md`、`需求规范.md`、`需求审核规范.md`、`需求总纲.md`、`需求设计.md`、`需求执行日志.md`、`需求审计报告.md`、`需求问题记录.md` 存在。 +3. 每个正式文档都有：创建人员、文件职责、管理规范/模板、引用文件、记录方式。 +4. 本地规范明确引用 common 对应规范，并说明不得削弱 common 硬约束。 +5. 不存在从其他项目复制来的具体需求、旧路径、旧结论或旧业务内容。 + +### 6.2 项目配置和入口校验 + +检查： + +1. 项目根目录 `项目配置清单.md` 已登记需求体系启用状态、目录、common 规范、本地规范、需求 AI、需求审核员。 +2. 项目执行日志记录了启用需求体系的动作。 +3. 项目变更记录已登记需求体系启用。 +4. `pro-doc/目录导读.md` 能指到总纲、设计、执行日志、审计报告和问题记录。 + +### 6.3 证据链 dry-run 校验 + +用一个不代表真实业务结论的测试事项，例如 `PRO-SMOKE-001`，做证据链 dry-run。 + +最小链路： + +```text +需求总纲：记录 PRO-SMOKE-001 的来源、目标、边界 +-> 需求设计：记录 DESIGN-PRO-SMOKE-001 的方案和验收 +-> 需求执行日志：记录 RUN-PRO-SMOKE-001 的关键步骤和产物位置 +-> 需求审计报告：记录 AUDIT-PRO-SMOKE-001 的初始化 / dry-run 审计结论 +-> 需求问题记录：仅在存在非审计来源问题或需要审计问题索引时使用 +``` + +通过标准： + +1. 各文档之间的 ID 能互相引用。 +2. 人或 AI 能从需求总纲一路追到设计、执行日志和审计报告。 +3. 如果没有真实需求产物，执行日志要明确写“dry-run，无真实业务产物”。 +4. 审计问题主记录写在需求审计报告；需求问题记录不被误用成审计问题主账。 + +## 7. 完成标准 + +需求环境可用，至少满足： + +1. `pro-doc/` 存在。 +2. 本地需求规范、需求审核规范、总纲、设计、执行日志、审计报告、问题记录存在。 +3. 项目配置清单已登记需求体系。 +4. 体系创建校验通过。 +5. 初始化审计通过。 + +## 8. 禁止事项 + +禁止： + +1. 只创建目录不创建入口文档。 +2. 未做设计审核就把正式需求交给开发。 +3. 把临时草稿当正式需求。 +4. 把其他项目的需求文档复制进新项目当正式产物。 +5. 把需求写成过重的发布 gate 系统。 diff --git "a/common/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" "b/common/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" index 5d34845..3f32a39 100644 --- "a/common/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" @@ -1,9 +1,9 @@ -# 需求规范 +# 需求规范 创建人员：Codex 文件职责：定义通用需求文档写法、需求审核流程、需求进入编码阶段的条件。 -管理规范/模板：../../全局规范.md；产品规范.md；产品审核规范.md；需求文档范本.md。 -引用文件：产品规范.md；产品审核规范.md；需求文档范本.md；../dev-doc/编码规范.md。 +管理规范/模板：../../全局规范.md；需求规范.md；需求审核规范.md；需求文档范本.md。 +引用文件：需求规范.md；需求审核规范.md；需求文档范本.md；../dev-doc/编码规范.md。 记录方式：全局需求写作规范；需求写法、需求审核流程或进入编码阶段的条件变化时更新。 ## 1. 目标 @@ -89,12 +89,12 @@ 需求按规模分两类处理，不要把所有需求都套进重流程。 -需求文档进入审核前，必须先判断上游产品流程： +需求文档进入审核前，必须先判断上游需求流程： -1. 大量产品修改：必须先有产品方案文档，且产品审核通过。 -2. 少量产品修改：可以直接改需求文档，但必须记录修改背景和一致性检查结论。 -3. 第一版复杂产品交付：必须先有架构文档、模块说明文档、核心流程文档，且产品审核通过。 -4. 第一版轻量产品交付：可以直接进入需求文档书写流程。 +1. 大量需求修改：必须先有需求方案文档，且需求审核通过。 +2. 少量需求修改：可以直接改需求文档，但必须记录修改背景和一致性检查结论。 +3. 第一版复杂需求交付：必须先有架构文档、模块说明文档、核心流程文档，且需求审核通过。 +4. 第一版轻量需求交付：可以直接进入需求文档书写流程。 如果对应上游文档不存在，需求文档必须说明“不适用”和原因，不能假装已经参考。 @@ -163,7 +163,7 @@ 3. 写清输入、输出、字段、状态、错误处理。 4. 写清核心处理流程和不做事项。 5. 写清验收标准，区分主流程必过项和外部诊断项。 -6. 对照产品方案或三大文档做一致性检查。 +6. 对照需求方案或三大文档做一致性检查。 7. 检查需求之间是否存在冲突或重复定义。 8. 交审核员审核。 9. 审核员通过后，需求完成。 @@ -379,29 +379,29 @@ 如果实现者可能按两种方式理解，就还不是合格需求。 -## 13A. 产品上游一致性检查 +## 13A. 需求上游一致性检查 -无论新写需求还是修改需求，都必须做产品上游一致性检查。 +无论新写需求还是修改需求，都必须做需求上游一致性检查。 检查对象： -1. 产品方案文档：有就参考，没有就说明不适用。 +1. 需求方案文档：有就参考，没有就说明不适用。 2. 架构文档：有就参考，没有就说明不适用。 3. 模块说明文档：有就参考，没有就说明不适用。 4. 核心流程文档：有就参考，没有就说明不适用。 -5. 产品总纲里的目标、背景、边界和关键聊天要求。 +5. 需求总纲里的目标、背景、边界和关键聊天要求。 6. 相关旧需求文档。 检查结论必须能回答： -1. 需求是否和产品方案一致。 +1. 需求是否和需求方案一致。 2. 需求是否和架构、模块说明、核心流程一致。 3. 是否有冲突。 4. 是否漏写必须实现的需求。 -5. 是否引入产品文档没有授权的新口径。 +5. 是否引入需求文档没有授权的新口径。 6. 是否把小需求写成重型系统。 -推荐在需求文档中增加“产品上游一致性检查”小节。轻量需求也要写，但可以很短。 +推荐在需求文档中增加“需求上游一致性检查”小节。轻量需求也要写，但可以很短。 ## 14. 公式、规则和阈值 diff --git "a/common/pro-doc/\344\272\247\345\223\201\350\256\276\350\256\241\346\250\241\347\211\210.md" "b/common/pro-doc/\351\234\200\346\261\202\350\256\276\350\256\241\346\250\241\347\211\210.md" similarity index 69% rename from "common/pro-doc/\344\272\247\345\223\201\350\256\276\350\256\241\346\250\241\347\211\210.md" rename to "common/pro-doc/\351\234\200\346\261\202\350\256\276\350\256\241\346\250\241\347\211\210.md" index 92bd278..8195a18 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\350\256\276\350\256\241\346\250\241\347\211\210.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\350\256\276\350\256\241\346\250\241\347\211\210.md" @@ -1,44 +1,44 @@ -# 产品设计 +# 需求设计 创建人员：<创建人员> -文件职责：记录产品事项的设计方案、输入输出、处理口径、验收方式和进入下游体系的条件。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品设计模版.md。 -引用文件：产品总纲.md；产品执行日志.md；产品审计报告.md；产品问题记录.md；需求规范.md；需求文档范本.md。 -记录方式：append-only；每个产品事项或设计版本追加一条设计记录，最新设计放在文档末尾。 +文件职责：记录需求事项的设计方案、输入输出、处理口径、验收方式和进入下游体系的条件。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求设计模版.md。 +引用文件：需求总纲.md；需求执行日志.md；需求审计报告.md；需求问题记录.md；需求规范.md；需求文档范本.md。 +记录方式：append-only；每个需求事项或设计版本追加一条设计记录，最新设计放在文档末尾。 ## 1. 文档作用 本文件用于回答： -1. 这个产品事项准备怎么做。 -2. 设计是否能满足产品总纲里的目标。 +1. 这个需求事项准备怎么做。 +2. 设计是否能满足需求总纲里的目标。 3. 输入、输出、边界、验收是什么。 4. 是否需要转成需求、开发、实验或案例分析。 5. 审核员应该按什么口径审核。 ## 2. 设计索引 -| 设计 ID | 产品事项 ID | 设计名称 | 当前状态 | 审计 ID | 下游去向 | 最新结论 | +| 设计 ID | 需求事项 ID | 设计名称 | 当前状态 | 审计 ID | 下游去向 | 最新结论 | |---|---|---|---|---|---|---| | <DESIGN-PRO-001-V1> | <PRO-001> | <设计名称> | 草案 / 待审 / 通过 / 驳回 / 暂停 | <AUDIT-ID> | 需求 / 开发 / 实验 / 案例分析 / 归档 | <一句话结论> | -## 3. 产品设计记录模板 +## 3. 需求设计记录模板 ### <DESIGN-PRO-001-V1> <设计名称> 记录时间：<YYYY-MM-DD HH:mm:ss> 设计人：<AI 或人员> -关联产品事项：<PRO-001> +关联需求事项：<PRO-001> 当前状态：草案 / 待审 / 通过 / 驳回 / 暂停 #### 3.0 流程分流判断 本事项属于： -1. 大量产品修改：是 / 否。 -2. 少量产品修改：是 / 否。 -3. 第一版复杂产品交付：是 / 否。 -4. 第一版轻量产品交付：是 / 否。 +1. 大量需求修改：是 / 否。 +2. 少量需求修改：是 / 否。 +3. 第一版复杂需求交付：是 / 否。 +4. 第一版轻量需求交付：是 / 否。 判断理由： @@ -46,20 +46,20 @@ <为什么走这条流程。> ``` -需要先写的产品文档： +需要先写的需求文档： | 文档 | 是否需要 | 原因 | 路径 | |---|---|---|---| -| 产品方案文档 | 是 / 否 | <原因> | <路径或不适用> | +| 需求方案文档 | 是 / 否 | <原因> | <路径或不适用> | | 架构文档 | 是 / 否 | <原因> | <路径或不适用> | | 模块说明文档 | 是 / 否 | <原因> | <路径或不适用> | | 核心流程文档 | 是 / 否 | <原因> | <路径或不适用> | #### 3.1 目标对齐 -产品总纲目标： +需求总纲目标： -1. <从产品总纲引用的目标> +1. <从需求总纲引用的目标> 本设计如何满足目标： @@ -69,9 +69,9 @@ 原则： -1. 不把产品设计写成代码实现细节。 +1. 不把需求设计写成代码实现细节。 2. 不把轻量需求做成重型流程。 -3. 不把实验、开发、案例分析的职责塞回产品体系。 +3. 不把实验、开发、案例分析的职责塞回需求体系。 4. 关键口径必须能被审核员复核。 项目补充原则： @@ -88,7 +88,7 @@ | 输出项 | 类型 | 路径或命名 | 是否正式产物 | 说明 | |---|---|---|---|---| -| <输出项> | 产品文档 / 需求文档 / 策略说明 / 规则说明 / 其他 | <路径> | 是 / 否 | <说明> | +| <输出项> | 需求文档 / 需求文档 / 策略说明 / 规则说明 / 其他 | <路径> | 是 / 否 | <说明> | #### 3.5 处理流程 @@ -96,7 +96,7 @@ 2. <步骤 2> 3. <步骤 3> -关键节点必须写入 `产品执行日志.md`。 +关键节点必须写入 `需求执行日志.md`。 #### 3.6 边界和不做事项 @@ -112,7 +112,7 @@ 验收标准： -1. 设计目标能覆盖产品总纲目标。 +1. 设计目标能覆盖需求总纲目标。 2. 输入输出清楚。 3. 下游去向清楚。 4. 不存在会导致实现分叉的模糊口径。 @@ -120,7 +120,7 @@ 需要审核： -1. 产品设计审核。 +1. 需求设计审核。 2. 如产出需求文档，还需要需求口径审核。 #### 3.8 下游交接 diff --git "a/common/pro-doc/\344\272\247\345\223\201\351\227\256\351\242\230\350\256\260\345\275\225\346\250\241\347\211\210.md" "b/common/pro-doc/\351\234\200\346\261\202\351\227\256\351\242\230\350\256\260\345\275\225\346\250\241\347\211\210.md" similarity index 78% rename from "common/pro-doc/\344\272\247\345\223\201\351\227\256\351\242\230\350\256\260\345\275\225\346\250\241\347\211\210.md" rename to "common/pro-doc/\351\234\200\346\261\202\351\227\256\351\242\230\350\256\260\345\275\225\346\250\241\347\211\210.md" index 97e1640..d760dc8 100644 --- "a/common/pro-doc/\344\272\247\345\223\201\351\227\256\351\242\230\350\256\260\345\275\225\346\250\241\347\211\210.md" +++ "b/common/pro-doc/\351\234\200\346\261\202\351\227\256\351\242\230\350\256\260\345\275\225\346\250\241\347\211\210.md" @@ -1,9 +1,9 @@ -# 产品问题记录 +# 需求问题记录 创建人员：<创建人员> -文件职责：记录非审计来源的产品问题、人工反馈问题、跨轮问题索引和长期跟踪项。 -管理规范/模板：../../common/pro-doc/产品规范.md；../../common/pro-doc/产品问题记录模版.md。 -引用文件：产品总纲.md；产品设计.md；产品执行日志.md；产品审计报告.md。 +文件职责：记录非审计来源的需求问题、人工反馈问题、跨轮问题索引和长期跟踪项。 +管理规范/模板：../../common/pro-doc/需求规范.md；../../common/pro-doc/需求问题记录模版.md。 +引用文件：需求总纲.md；需求设计.md；需求执行日志.md；需求审计报告.md。 记录方式：append-only；新增问题、状态变化、复验结论时追加记录。 ## 1. 文档作用 @@ -13,7 +13,7 @@ 使用规则： 1. 非审计人员发现的问题，主记录写在本文件。 -2. 审核员在审计中发现的问题，主记录写在 `产品审计报告.md`。 +2. 审核员在审计中发现的问题，主记录写在 `需求审计报告.md`。 3. 审计问题如果需要跨轮跟踪，可以在本文件写索引，但不要重复全文。 ## 2. 问题索引 @@ -29,7 +29,7 @@ 记录时间：<YYYY-MM-DD HH:mm:ss> 记录人：<AI 或人员> 来源类型：非审计反馈 / 审计问题索引 -关联产品事项：<PRO-001> +关联需求事项：<PRO-001> 关联设计：<DESIGN-ID 或无> 严重级别：阻断 / 非阻断 / 建议 当前状态：待处理 / 修复中 / 待复验 / 已关闭 diff --git "a/common/project-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/common/project-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" index fa45a75..01d43a1 100644 --- "a/common/project-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" +++ "b/common/project-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -12,7 +12,7 @@ 项目体系负责管理“一个项目本身”，包括项目目标、项目配置清单、启用体系、角色权限、目录结构、项目事项计划、项目执行日志、项目事项审计和项目级问题闭环。 -项目体系不是产品体系、开发体系、实验体系的替代品。它负责把这些体系装进项目，并维护项目层面的治理入口。 +项目体系不是需求体系、开发体系、实验体系的替代品。它负责把这些体系装进项目，并维护项目层面的治理入口。 ## 2. 文件清单 diff --git "a/common/project-doc/\351\241\271\347\233\256\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" "b/common/project-doc/\351\241\271\347\233\256\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" index 6044cfc..1463164 100644 --- "a/common/project-doc/\351\241\271\347\233\256\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" +++ "b/common/project-doc/\351\241\271\347\233\256\347\216\257\345\242\203\345\210\233\345\273\272\346\214\207\345\215\227.md" @@ -10,7 +10,7 @@ 当项目管理员要创建一个新项目时，按本指南执行。 -本指南只负责项目体系初始化，不替代产品、编码、实验、数据、案例分析等具体体系的创建指南。 +本指南只负责项目体系初始化，不替代需求、编码、实验、数据、案例分析等具体体系的创建指南。 ## 2. 输入 @@ -101,7 +101,7 @@ 常见体系： -1. 产品体系：`pro-doc/` +1. 需求体系：`pro-doc/` 2. 开发体系：项目创建时按 `common/dev-doc/开发环境创建指南.md` 的 `root_default` 模式默认创建；具体目标开发工作区按该指南的 `target_workspace` 模式创建，例如 `dev/pro-dev/`、`dev-doc/pro-doc/`，但目标文档区只放目标代码文档和方案附件 3. 实验体系：`exp-doc/`、`exp-data/` 4. 案例分析体系：`ana-doc/`、`ana-data/` diff --git "a/common/project-doc/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225\346\250\241\347\211\210.md" "b/common/project-doc/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225\346\250\241\347\211\210.md" index e2a25c5..f8ca9c1 100644 --- "a/common/project-doc/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225\346\250\241\347\211\210.md" +++ "b/common/project-doc/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225\346\250\241\347\211\210.md" @@ -22,7 +22,7 @@ | 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | |---|---|---|---|---|---|---| | 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | <CHANGE-ID> | -| 产品体系 | 否 | pro-doc/ | ../common/pro-doc/产品规范.md；../common/pro-doc/需求规范.md | pro-doc/产品规范.md；pro-doc/需求规范.md | 产品 AI | | +| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md；../common/pro-doc/需求审核规范.md | pro-doc/需求规范.md；pro-doc/需求审核规范.md | 需求 AI；需求审核员 | | | 开发体系 | 是 | dev/；dev/test/；dev/tmp/；dev-doc/；目标开发工作区按需创建 | ../common/dev-doc/开发环境创建指南.md；../common/dev-doc/编码规范.md；../common/dev-doc/开发审计规范.md | dev-doc/目录导读.md；dev-doc/编码规范.md；dev-doc/开发审计规范.md；dev-doc/开发事项总纲.md；dev-doc/开发事项计划.md；dev-doc/开发执行日志.md；dev-doc/开发审计报告.md；dev-doc/开发问题记录.md；重型开发方案按事项创建到开发方案目录；目标开发工作区创建后登记 | 开发 AI | <CHANGE-ID> | | 实验体系 | 否 | exp-doc/；exp-data/ | ../common/exp-doc/实验规范.md | exp-doc/实验规范.md | 实验员 | | | 案例分析体系 | 否 | ana-doc/；ana-data/ | ../common/ana-doc/案例分析规范.md | ana-doc/案例分析规范.md | 案例分析员 | | @@ -41,7 +41,7 @@ | 角色 | 默认写权限目录 | 说明 | |---|---|---| | 项目管理员 | 项目根目录 | 管理项目规范、项目配置清单、项目级账本和体系启用 | -| 产品 AI | pro-doc/ | 需求、产品、策略文档 | +| 需求 AI | pro-doc/ | 需求、策略文档 | | 开发 AI | dev/<target>-dev/；dev/<target>-dev/test/；dev-doc/<target>-doc/ | 代码、测试、目标代码文档和方案附件；正式开发账本统一在 dev-doc/ 根目录 | | 实验员 | exp-doc/；exp-data/ | 实验文档、实验数据、结果包 | | 案例分析员 | ana-doc/；ana-data/ | 案例分析文档、案例数据、图片 | diff --git "a/project A/\351\241\271\347\233\256\350\247\204\350\214\203.md" "b/project A/\351\241\271\347\233\256\350\247\204\350\214\203.md" index ca423d2..7d5e0e6 100644 --- "a/project A/\351\241\271\347\233\256\350\247\204\350\214\203.md" +++ "b/project A/\351\241\271\347\233\256\350\247\204\350\214\203.md" @@ -1,4 +1,4 @@ -# 项目规范 +# 项目规范 创建人员：Codex 文件职责：记录 Project A 的项目目标、边界、项目配置入口和本地补充规则。 @@ -31,7 +31,7 @@ 本项目不做： 1. 不导入外部项目真实数据。 -2. 不把合成样例结论读成真实策略、产品或业务结论。 +2. 不把合成样例结论读成真实策略、需求或业务结论。 ## 4. 项目配置入口 diff --git "a/project A/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/project A/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" index 7a771ec..b56a4e7 100644 --- "a/project A/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" +++ "b/project A/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -1,4 +1,4 @@ -# 项目配置清单 +# 项目配置清单 创建人员：Codex 文件职责：记录 Project A 当前启用体系、AI 角色、权限边界、工作空间、目录映射和核心文档入口，是项目当前配置的事实源。 @@ -53,7 +53,7 @@ | dev-doc/ | 开发文档根目录；目标开发文档放到 dev-doc/<target>-doc/ | 开发 AI | 已创建 | 项目创建默认存在 | | exp-doc/；exp-data/ | 实验体系文档和数据 | 实验员 | 已创建 | 既有实验体系 | | ana-doc/；ana-data/ | 案例分析体系文档和数据 | 案例分析员 | 已创建 | 本轮新增 | -| pro-doc/ | 需求/产品文档 | 产品 AI | 已创建 | 既有目录 | +| pro-doc/ | 需求文档 | 需求 AI | 已创建 | 既有目录 | ## 6. 核心文档入口 diff --git "a/project B/\351\241\271\347\233\256\350\247\204\350\214\203.md" "b/project B/\351\241\271\347\233\256\350\247\204\350\214\203.md" index b107205..8165fe0 100644 --- "a/project B/\351\241\271\347\233\256\350\247\204\350\214\203.md" +++ "b/project B/\351\241\271\347\233\256\350\247\204\350\214\203.md" @@ -1,4 +1,4 @@ -# 项目规范 +# 项目规范 创建人员：Codex 文件职责：记录 Project B 的项目目标、边界、项目配置入口和本地补充规则。 @@ -31,7 +31,7 @@ 本项目不做： 1. 不导入外部项目真实数据。 -2. 不把合成案例结论读成真实策略、产品或业务结论。 +2. 不把合成案例结论读成真实策略、需求或业务结论。 ## 4. 项目配置入口 diff --git "a/project C/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/project C/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" index 69239b9..3cb7bc5 100644 --- "a/project C/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" +++ "b/project C/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -22,7 +22,7 @@ | 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | |---|---|---|---|---|---|---| | 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | PC-CHANGE-001 | -| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 产品 AI | | +| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 需求 AI | | | 开发体系 | 是 | dev/；dev-doc/；目标开发工作区按需创建 | ../common/dev-doc/编码规范.md | 目标开发工作区创建后登记 | 开发 AI | PC-CHANGE-003 | | 实验体系 | 否 | exp-doc/；exp-data/ | ../common/exp-doc/实验规范.md | exp-doc/实验规范.md | 实验员 | | | 案例分析体系 | 否 | ana-doc/；ana-data/ | ../common/ana-doc/案例分析规范.md | ana-doc/案例分析规范.md | 案例分析员 | | diff --git "a/project-ai-workspace-check/ai-lena/worklog/\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" "b/project-ai-workspace-check/ai-lena/worklog/\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" new file mode 100644 index 0000000..feea22d --- /dev/null +++ "b/project-ai-workspace-check/ai-lena/worklog/\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" @@ -0,0 +1,12 @@ +# 首次阅读反馈 + +创建人员：Codex +文件职责：记录 Lena 首次阅读工作说明后的理解反馈。 +管理规范/模板：../../common/ai-workplace/AI工作空间创建指南.md。 +引用文件：../工作说明.md。 +记录方式：一次性反馈；角色变化后追加新反馈。 + +## 1. 理解反馈 + +我能理解自己是需求 AI + 开发 AI（需求开发）。需求工作先读需求规范和需求规范；需求开发还必须读编码规范、开发审计规范和需求开发目标工作区说明。正式产物不写在 ai-lena 工作空间里。 + diff --git "a/project-ai-workspace-check/ai-lena/\345\267\245\344\275\234\350\257\264\346\230\216.md" "b/project-ai-workspace-check/ai-lena/\345\267\245\344\275\234\350\257\264\346\230\216.md" new file mode 100644 index 0000000..9e287a8 --- /dev/null +++ "b/project-ai-workspace-check/ai-lena/\345\267\245\344\275\234\350\257\264\346\230\216.md" @@ -0,0 +1,64 @@ +# Lena 工作说明 + +创建人员：Codex +文件职责：记录 Lena 在 project-ai-workspace-check 中的角色入口、职责边界、权限范围和体系文档路由。 +管理规范/模板：../../全局规范.md；../项目规范.md；../项目配置清单.md；../../common/ai-workplace/AI工作空间创建指南.md。 +引用文件：../项目配置清单.md；../项目执行日志.md；../项目变更记录.md；../pro-doc/需求规范.md；../dev-doc/编码规范.md。 +记录方式：当前配置说明；角色、权限或工作入口变化时覆盖更新，并在项目变更记录中保留历史。 + +## 1. 基本信息 + +| 字段 | 内容 | +|---|---| +| AI 名称 | Lena | +| 工作空间 | ai-lena/ | +| 指派人 | Codex | +| 指派时间 | 2026-06-03 | +| 指派原因 | 验证需求开发组合角色工作说明是否满足必读文档和权限边界 | + +## 2. 当前角色 + +| 角色 | 职责范围 | 默认写权限 | 关键规范 | +|---|---|---|---| +| 需求 AI | 编写需求事项、需求文档、需求设计和需求执行日志 | pro-doc/；ai-lena/ | pro-doc/需求规范.md；pro-doc/需求规范.md | +| 开发 AI（需求开发） | 根据需求文档实现需求相关代码、测试和开发自检 | dev/pro-dev/；dev/pro-dev/test/；dev-doc/pro-doc/；ai-lena/ | dev-doc/编码规范.md；dev-doc/开发审计规范.md | + +## 3. 必读文档入口 + +| 场景 | 先读文档 | 用途 | +|---|---|---| +| 项目基础 | ../项目配置清单.md；../项目规范.md | 确认角色、权限、已启用体系和项目规则 | +| 需求工作 | ../pro-doc/需求规范.md；../pro-doc/需求规范.md；../pro-doc/需求总纲.md；../pro-doc/需求设计.md；../pro-doc/需求执行日志.md；../pro-doc/需求审计报告.md | 按需求体系做需求事项和需求事项 | +| 需求开发 | ../dev-doc/编码规范.md；../dev-doc/开发审计规范.md；../dev-doc/开发事项总纲.md；../dev-doc/开发事项计划.md；../dev-doc/开发执行日志.md；../dev-doc/开发审计报告.md；../dev-doc/pro-doc/开发工作区说明.md | 按开发体系实现需求相关代码，不把工作说明当开发规范 | +| 上游需求材料 | 相关需求方案、需求文档、需求架构文档、需求模块说明文档、需求核心流程文档 | 如果存在，需求开发前必须读取；不存在时在开发事项中说明不适用 | + +## 4. 目录入口 + +1. 私有草稿：`ai-lena/draft/` +2. 私有临时文件：`ai-lena/tmp/` +3. 私有过程记录：`ai-lena/worklog/` +4. 需求正式产物：`pro-doc/` +5. 需求开发代码：`dev/pro-dev/` +6. 需求开发测试：`dev/pro-dev/test/` +7. 需求开发文档区：`dev-doc/pro-doc/` +8. 开发根级账本：`dev-doc/开发事项总纲.md`、`dev-doc/开发事项计划.md`、`dev-doc/开发执行日志.md` + +## 5. 任务入口路由 + +1. 接到任务后先查 `../项目配置清单.md`，确认任务属于需求还是需求开发。 +2. 需求任务先读 `../pro-doc/需求规范.md` 和 `../pro-doc/需求规范.md`。 +3. 需求开发任务同时读 `../pro-doc/需求规范.md`、`../pro-doc/需求规范.md`、`../dev-doc/编码规范.md`、`../dev-doc/开发审计规范.md`。 +4. 如果上游需求文档缺失或冲突，记录为需求问题并退回，不靠代码补口径。 +5. 工作说明只提供入口，具体流程以对应体系规范为准。 + +## 6. 审核边界 + +Lena 当前不是审核员。不得自行把自己的需求或开发产物标记为审核通过。 + +## 7. 禁止事项 + +1. 不得把 `ai-lena/` 当正式产物目录。 +2. 不得绕过 `项目配置清单.md` 新增权限。 +3. 不得把需求正式交付事项按无需求文档轻量实现处理。 +4. 不得把目标开发代码写到 `dev/` 根目录。 + diff --git "a/project-ai-workspace-check/ai-omar/worklog/\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" "b/project-ai-workspace-check/ai-omar/worklog/\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" new file mode 100644 index 0000000..7f45ac6 --- /dev/null +++ "b/project-ai-workspace-check/ai-omar/worklog/\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" @@ -0,0 +1,11 @@ +# 首次阅读反馈 + +创建人员：Codex +文件职责：记录 Omar 首次阅读工作说明后的理解反馈。 +管理规范/模板：../../common/ai-workplace/AI工作空间创建指南.md。 +引用文件：../工作说明.md。 +记录方式：一次性反馈；角色变化后追加新反馈。 + +## 1. 理解反馈 + +我能理解自己是需求审核员 + 开发审核员。需求审核要读需求规范和需求审核规范；开发审核要读编码规范和开发审计规范；组合审核还要追需求事项账本、开发事项账本和被审证据链。 diff --git "a/project-ai-workspace-check/ai-omar/\345\267\245\344\275\234\350\257\264\346\230\216.md" "b/project-ai-workspace-check/ai-omar/\345\267\245\344\275\234\350\257\264\346\230\216.md" new file mode 100644 index 0000000..aef677d --- /dev/null +++ "b/project-ai-workspace-check/ai-omar/\345\267\245\344\275\234\350\257\264\346\230\216.md" @@ -0,0 +1,62 @@ +# Omar 工作说明 + +创建人员：Codex +文件职责：记录 Omar 在 project-ai-workspace-check 中的角色入口、职责边界、权限范围和体系文档路由。 +管理规范/模板：../../全局规范.md；../项目规范.md；../项目配置清单.md；../../common/ai-workplace/AI工作空间创建指南.md。 +引用文件：../项目配置清单.md；../项目执行日志.md；../项目变更记录.md；../pro-doc/需求审核规范.md；../dev-doc/开发审计规范.md。 +记录方式：当前配置说明；角色、权限或工作入口变化时覆盖更新，并在项目变更记录中保留历史。 + +## 1. 基本信息 + +| 字段 | 内容 | +|---|---| +| AI 名称 | Omar | +| 工作空间 | ai-omar/ | +| 指派人 | Codex | +| 指派时间 | 2026-06-03 | +| 指派原因 | 验证需求-开发审核员工作说明是否同时覆盖需求、开发和审核规范 | + +## 2. 当前角色 + +| 角色 | 职责范围 | 默认写权限 | 关键规范 | +|---|---|---|---| +| 审核员（需求审核） | 审核需求设计、需求文档、需求验收和需求证据链 | pro-doc/需求审计报告.md；ai-omar/ | pro-doc/需求规范.md；pro-doc/需求审核规范.md；pro-doc/需求规范.md | +| 审核员（开发审核） | 审核需求开发事项计划、实现、自测、需求-代码一致性和开发证据链 | dev-doc/开发审计报告.md；ai-omar/ | dev-doc/编码规范.md；dev-doc/开发审计规范.md | + +## 3. 必读文档入口 + +| 场景 | 先读文档 | 用途 | +|---|---|---| +| 项目基础 | ../项目配置清单.md；../项目规范.md | 确认角色、权限、已启用体系和项目规则 | +| 需求审核 | ../pro-doc/需求规范.md；../pro-doc/需求规范.md；../pro-doc/需求审核规范.md；../pro-doc/需求总纲.md；../pro-doc/需求设计.md；../pro-doc/需求执行日志.md；../pro-doc/需求审计报告.md | 同时理解需求怎么做和需求怎么审 | +| 开发审核 | ../dev-doc/编码规范.md；../dev-doc/开发审计规范.md；../dev-doc/开发事项总纲.md；../dev-doc/开发事项计划.md；../dev-doc/开发执行日志.md；../dev-doc/开发审计报告.md；../dev-doc/pro-doc/开发工作区说明.md | 同时理解开发怎么做和开发怎么审 | +| 被审对象证据 | 相关需求方案、需求文档、需求架构 / 模块说明 / 核心流程文档、开发事项账本、代码变更和测试结果 | 审核必须对齐被审事项和证据链，不只看审计规范 | + +## 4. 目录入口 + +1. 私有草稿：`ai-omar/draft/` +2. 私有临时文件：`ai-omar/tmp/` +3. 私有过程记录：`ai-omar/worklog/` +4. 需求审计入口：`pro-doc/需求审计报告.md` +5. 开发审计入口：`dev-doc/开发审计报告.md` +6. 需求事项账本：`pro-doc/需求总纲.md`、`pro-doc/需求设计.md`、`pro-doc/需求执行日志.md` +7. 开发事项账本：`dev-doc/开发事项总纲.md`、`dev-doc/开发事项计划.md`、`dev-doc/开发执行日志.md` + +## 5. 任务入口路由 + +1. 接到审核任务后先查 `../项目配置清单.md`，确认审核范围是需求、开发还是需求-开发组合。 +2. 需求审核必须同时读需求规范、需求审核规范和被审需求账本。 +3. 开发审核必须同时读编码规范、开发审计规范和被审开发账本。 +4. 需求-开发组合审核必须同时覆盖需求交付、开发接收、开发回交和需求验收链路。 +5. 审核意见写入对应审计报告，不直接修改被审主产物。 + +## 6. 审核边界 + +Omar 可以读取证据链和运行只读检查。Omar 不直接改需求主产物、需求文档、业务代码或测试代码。若未来同时参与执行和审核，必须在审计报告中标注自审。 + +## 7. 禁止事项 + +1. 不得只看需求审核规范而不读需求规范。 +2. 不得只看开发审计规范而不读编码规范。 +3. 不得只写“通过”而不列可复核证据。 +4. 不得直接修改被审计主产物。 diff --git "a/project-ai-workspace-check/dev-doc/pro-doc/\345\274\200\345\217\221\345\267\245\344\275\234\345\214\272\350\257\264\346\230\216.md" "b/project-ai-workspace-check/dev-doc/pro-doc/\345\274\200\345\217\221\345\267\245\344\275\234\345\214\272\350\257\264\346\230\216.md" new file mode 100644 index 0000000..d2444bb --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/pro-doc/\345\274\200\345\217\221\345\267\245\344\275\234\345\214\272\350\257\264\346\230\216.md" @@ -0,0 +1,20 @@ +# 开发工作区说明 + +创建人员：Codex +文件职责：记录需求开发目标工作区的代码入口、测试入口、所属事项、方案附件和根级开发账本回写位置。 +管理规范/模板：../../common/dev-doc/开发环境创建指南.md；../编码规范.md；../开发审计规范.md。 +引用文件：../开发事项总纲.md；../开发事项计划.md；../开发执行日志.md；../开发审计报告.md；../开发问题记录.md。 +记录方式：目标开发工作区说明；代码入口、测试入口或关联事项变化时更新。 + +## 1. 基本口径 + +本目录不是独立开发体系，只是需求开发目标代码文档区。正式开发事项统一登记到 `dev-doc/` 根级开发账本。 + +## 2. 目录映射 + +| 路径 | 作用 | +|---|---| +| dev/pro-dev/ | 需求开发代码目录 | +| dev/pro-dev/test/ | 需求开发测试目录 | +| dev-doc/pro-doc/ | 需求开发目标文档区 | + diff --git "a/project-ai-workspace-check/dev-doc/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/project-ai-workspace-check/dev-doc/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" new file mode 100644 index 0000000..e0e40d4 --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -0,0 +1,16 @@ +# 目录导读 + +创建人员：Codex +文件职责：说明需求开发目标工作区的文档入口。 +管理规范/模板：../../common/dev-doc/开发环境创建指南.md；../编码规范.md。 +引用文件：开发工作区说明.md；../开发事项总纲.md；../开发事项计划.md；../开发执行日志.md；../开发审计报告.md。 +记录方式：目标工作区入口；入口变化时更新。 + +## 1. 入口 + +| 路径 | 作用 | +|---|---| +| ../../dev/pro-dev/ | 需求开发代码目录 | +| ../../dev/pro-dev/test/ | 需求开发测试目录 | +| 开发工作区说明.md | 目标工作区说明 | + diff --git "a/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262.md" "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262.md" new file mode 100644 index 0000000..205c445 --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\346\200\273\347\272\262.md" @@ -0,0 +1,15 @@ +# 开发事项总纲 + +创建人员：Codex +文件职责：记录开发事项背景、目标、边界、状态和结论。 +管理规范/模板：../common/dev-doc/开发事项总纲模版.md；编码规范.md。 +引用文件：开发事项计划.md；开发执行日志.md；开发审计报告.md。 +记录方式：append-only 开发账本；最新事项追加到末尾。 + +## DEV-AIWS-001：需求开发目标工作区验证 + +| 字段 | 内容 | +|---|---| +| 目标 | 验证需求开发 target workspace 创建并被工作说明引用 | +| 状态 | 已验证 | + diff --git "a/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\350\256\241\345\210\222.md" "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\350\256\241\345\210\222.md" new file mode 100644 index 0000000..f0869fd --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\344\272\213\351\241\271\350\256\241\345\210\222.md" @@ -0,0 +1,16 @@ +# 开发事项计划 + +创建人员：Codex +文件职责：记录开发计划、步骤、输入输出、验收方式和审计入口。 +管理规范/模板：../common/dev-doc/开发事项计划模版.md；编码规范.md。 +引用文件：开发事项总纲.md；开发执行日志.md；开发审计报告.md。 +记录方式：append-only 开发计划账本；最新计划追加到末尾。 + +## PLAN-DEV-AIWS-001 + +| 字段 | 内容 | +|---|---| +| 对应事项 | DEV-AIWS-001 | +| 步骤 | 创建 dev/pro-dev、dev/pro-dev/test、dev-doc/pro-doc，并写入工作区说明 | +| 验收 | target_workspace 校验通过 | + diff --git "a/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\345\256\241\350\256\241\346\212\245\345\221\212.md" "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\345\256\241\350\256\241\346\212\245\345\221\212.md" new file mode 100644 index 0000000..8942efc --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\345\256\241\350\256\241\346\212\245\345\221\212.md" @@ -0,0 +1,16 @@ +# 开发审计报告 + +创建人员：Codex +文件职责：记录方案审核、实现审核、测试验收和复审结论。 +管理规范/模板：../common/dev-doc/开发审计报告模版.md；开发审计规范.md。 +引用文件：编码规范.md；开发事项总纲.md；开发事项计划.md；开发执行日志.md。 +记录方式：append-only 开发审计账本；最新记录追加到末尾。 + +## AUDIT-DEV-AIWS-001 + +| 字段 | 内容 | +|---|---| +| 对应事项 | DEV-AIWS-001 | +| 结论 | PASS | +| 说明 | 需求开发目标工作区存在，且没有复制第二套开发账本 | + diff --git "a/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\345\256\241\350\256\241\350\247\204\350\214\203.md" "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\345\256\241\350\256\241\350\247\204\350\214\203.md" new file mode 100644 index 0000000..8996cf7 --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\345\256\241\350\256\241\350\247\204\350\214\203.md" @@ -0,0 +1,12 @@ +# 开发审计规范 + +创建人员：Codex +文件职责：记录本项目开发审核员必须遵守的本地审计规范。 +管理规范/模板：../common/dev-doc/开发审计规范.md。 +引用文件：编码规范.md；开发审计报告.md；开发问题记录.md。 +记录方式：本地开发审计规范；如有项目特化审计规则，追加到本文。 + +## 1. 基本口径 + +本项目所有开发审核员必须同时遵守 `../common/dev-doc/开发审计规范.md` 和本文件。 + diff --git "a/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\346\211\247\350\241\214\346\227\245\345\277\227.md" "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\346\211\247\350\241\214\346\227\245\345\277\227.md" new file mode 100644 index 0000000..b5d7811 --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\346\211\247\350\241\214\346\227\245\345\277\227.md" @@ -0,0 +1,16 @@ +# 开发执行日志 + +创建人员：Codex +文件职责：记录编码、测试、自检、中间结果、异常和偏离。 +管理规范/模板：../common/dev-doc/开发执行日志模版.md；编码规范.md。 +引用文件：开发事项总纲.md；开发事项计划.md；开发审计报告.md。 +记录方式：append-only 开发执行日志；最新记录追加到末尾。 + +## LOG-DEV-AIWS-001 + +| 字段 | 内容 | +|---|---| +| 对应事项 | DEV-AIWS-001 | +| 动作 | 创建需求开发目标工作区 | +| 产物 | dev/pro-dev/；dev/pro-dev/test/；dev-doc/pro-doc/ | + diff --git "a/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\351\227\256\351\242\230\350\256\260\345\275\225.md" "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\351\227\256\351\242\230\350\256\260\345\275\225.md" new file mode 100644 index 0000000..917a858 --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\345\274\200\345\217\221\351\227\256\351\242\230\350\256\260\345\275\225.md" @@ -0,0 +1,10 @@ +# 开发问题记录 + +创建人员：Codex +文件职责：记录非审计来源开发问题；审计问题只记录索引。 +管理规范/模板：../common/dev-doc/开发问题记录模版.md；编码规范.md。 +引用文件：开发审计报告.md；开发执行日志.md。 +记录方式：append-only 问题账本。 + +当前无非审计来源开发问题。 + diff --git "a/project-ai-workspace-check/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/project-ai-workspace-check/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" new file mode 100644 index 0000000..54fd33e --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -0,0 +1,18 @@ +# 目录导读 + +创建人员：Codex +文件职责：说明本项目开发体系入口、代码目录、测试目录、开发账本和审计入口。 +管理规范/模板：../common/dev-doc/开发环境创建指南.md；../common/dev-doc/编码规范.md。 +引用文件：编码规范.md；开发审计规范.md；开发事项总纲.md；开发事项计划.md；开发执行日志.md；开发审计报告.md；开发问题记录.md。 +记录方式：开发体系入口；目录或入口变化时更新。 + +## 1. 入口 + +| 路径 | 作用 | +|---|---| +| ../dev/pro-dev/ | 需求开发代码目录 | +| ../dev/pro-dev/test/ | 需求开发测试目录 | +| pro-doc/ | 需求开发目标文档区 | +| 开发事项总纲.md | 根级开发事项账本 | +| 开发审计报告.md | 开发审计入口 | + diff --git "a/project-ai-workspace-check/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" "b/project-ai-workspace-check/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" new file mode 100644 index 0000000..19a10fc --- /dev/null +++ "b/project-ai-workspace-check/dev-doc/\347\274\226\347\240\201\350\247\204\350\214\203.md" @@ -0,0 +1,12 @@ +# 编码规范 + +创建人员：Codex +文件职责：记录本项目开发体系必须遵守的本地编码规范。 +管理规范/模板：../common/dev-doc/编码规范.md。 +引用文件：开发审计规范.md；开发事项总纲.md；开发事项计划.md；开发执行日志.md；开发审计报告.md；开发问题记录.md。 +记录方式：本地编码规范；如有项目特化开发规则，追加到本文。 + +## 1. 基本口径 + +本项目所有开发 AI 必须同时遵守 `../common/dev-doc/编码规范.md` 和本文件。 + diff --git "a/project-ai-workspace-check/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" "b/project-ai-workspace-check/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" new file mode 100644 index 0000000..69b1794 --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\347\233\256\345\275\225\345\257\274\350\257\273.md" @@ -0,0 +1,19 @@ +# 目录导读 + +创建人员：Codex +文件职责：说明本项目需求体系文档入口、账本职责和审计入口。 +管理规范/模板：../../common/pro-doc/需求环境创建指南.md；../../common/pro-doc/需求规范.md。 +引用文件：需求规范.md；需求审核规范.md；需求总纲.md；需求设计.md；需求执行日志.md；需求审计报告.md；需求问题记录.md。 +记录方式：需求体系入口；需求文档入口变化时更新。 + +## 1. 核心入口 + +| 文档 | 作用 | +|---|---| +| 需求规范.md | 本地需求规范入口 | +| 需求审核规范.md | 本地需求审核规范入口 | +| 需求总纲.md | 需求事项背景和目标账本 | +| 需求设计.md | 需求设计和需求拆解账本 | +| 需求执行日志.md | 需求执行关键节点 | +| 需求审计报告.md | 需求设计、需求和验收审计 | +| 需求问题记录.md | 非审计来源需求问题 | diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\345\256\241\346\240\270\350\247\204\350\214\203.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\345\256\241\346\240\270\350\247\204\350\214\203.md" new file mode 100644 index 0000000..4266859 --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\345\256\241\346\240\270\350\247\204\350\214\203.md" @@ -0,0 +1,11 @@ +# 需求审核规范 + +创建人员：Codex +文件职责：记录本项目需求审核员必须遵守的本地审核规范。 +管理规范/模板：../../common/pro-doc/需求审核规范.md。 +引用文件：需求规范.md；需求审计报告.md；需求问题记录.md。 +记录方式：本地审核规范；如有项目特化审核规则，追加到本文。 + +## 1. 基本口径 + +本项目所有需求审核员必须同时遵守 `../../common/pro-doc/需求审核规范.md` 和本文件。 diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\345\256\241\350\256\241\346\212\245\345\221\212.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\345\256\241\350\256\241\346\212\245\345\221\212.md" new file mode 100644 index 0000000..2732659 --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\345\256\241\350\256\241\346\212\245\345\221\212.md" @@ -0,0 +1,15 @@ +# 需求审计报告 + +创建人员：Codex +文件职责：记录需求设计审核、产物审核、需求审核和复审结论。 +管理规范/模板：../../common/pro-doc/需求审计报告模版.md；需求审核规范.md。 +引用文件：需求规范.md；需求总纲.md；需求设计.md；需求执行日志.md。 +记录方式：append-only 审计账本；最新记录追加到末尾。 + +## AUDIT-PRO-AIWS-001：需求开发角色验证审计 + +| 字段 | 内容 | +|---|---| +| 对应事项 | PRO-AIWS-001 | +| 结论 | PASS | +| 说明 | 需求开发 AI 和需求开发审核 AI 的工作说明均覆盖需求规范、需求审核规范、开发规范和审核规范 | diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\346\200\273\347\272\262.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\346\200\273\347\272\262.md" new file mode 100644 index 0000000..18c721e --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\346\200\273\347\272\262.md" @@ -0,0 +1,14 @@ +# 需求总纲 + +创建人员：Codex +文件职责：记录需求事项、需求事项、策略事项的背景、目标、边界、状态和结论。 +管理规范/模板：../../common/pro-doc/需求总纲模版.md；需求规范.md。 +引用文件：需求设计.md；需求执行日志.md；需求审计报告.md。 +记录方式：append-only 需求账本；最新事项追加到末尾。 + +## PRO-AIWS-001：需求开发角色验证 + +| 字段 | 内容 | +|---|---| +| 目标 | 验证需求开发 AI 的工作说明是否包含需求规范、需求审核规范、开发规范和目标开发工作区 | +| 状态 | 已验证 | diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\346\211\247\350\241\214\346\227\245\345\277\227.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\346\211\247\350\241\214\346\227\245\345\277\227.md" new file mode 100644 index 0000000..c9db39b --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\346\211\247\350\241\214\346\227\245\345\277\227.md" @@ -0,0 +1,16 @@ +# 需求执行日志 + +创建人员：Codex +文件职责：记录需求事项执行关键节点、产物和自检。 +管理规范/模板：../../common/pro-doc/需求执行日志模版.md；需求规范.md。 +引用文件：需求总纲.md；需求设计.md；需求审计报告.md。 +记录方式：append-only 需求执行日志；最新记录追加到末尾。 + +## RUN-PRO-AIWS-001：需求开发角色验证执行 + +| 字段 | 内容 | +|---|---| +| 对应事项 | PRO-AIWS-001 | +| 产物 | ai-lena/工作说明.md；ai-omar/工作说明.md；项目配置清单.md | +| 自检 | 需求开发和需求开发审核必读文档已覆盖 | + diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" new file mode 100644 index 0000000..c8a64e6 --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\350\247\204\350\214\203.md" @@ -0,0 +1,12 @@ +# 需求规范 + +创建人员：Codex +文件职责：记录本项目需求文档写作和审核的本地规范。 +管理规范/模板：../../common/pro-doc/需求规范.md。 +引用文件：需求规范.md；需求审核规范.md；../../common/pro-doc/需求文档范本.md。 +记录方式：本地需求规范；如有项目特化需求写作规则，追加到本文。 + +## 1. 基本口径 + +本项目所有需求文档必须同时遵守 `../../common/pro-doc/需求规范.md` 和本文件。 + diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\350\256\276\350\256\241.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\350\256\276\350\256\241.md" new file mode 100644 index 0000000..207b204 --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\350\256\276\350\256\241.md" @@ -0,0 +1,16 @@ +# 需求设计 + +创建人员：Codex +文件职责：记录需求事项设计、分流判断、输入输出、验收和下游交接。 +管理规范/模板：../../common/pro-doc/需求设计模版.md；需求规范.md。 +引用文件：需求总纲.md；需求规范.md；需求执行日志.md；需求审计报告.md。 +记录方式：append-only 需求设计账本；最新设计追加到末尾。 + +## DESIGN-PRO-AIWS-001：需求开发角色验证设计 + +| 字段 | 内容 | +|---|---| +| 对应事项 | PRO-AIWS-001 | +| 设计 | 创建需求开发 AI 和需求开发审核 AI，验证工作说明必读文档是否覆盖需求、开发和审核规范 | +| 验收 | AI 工作空间创建指南专项校验通过 | + diff --git "a/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\351\227\256\351\242\230\350\256\260\345\275\225.md" "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\351\227\256\351\242\230\350\256\260\345\275\225.md" new file mode 100644 index 0000000..b085b92 --- /dev/null +++ "b/project-ai-workspace-check/pro-doc/\351\234\200\346\261\202\351\227\256\351\242\230\350\256\260\345\275\225.md" @@ -0,0 +1,10 @@ +# 需求问题记录 + +创建人员：Codex +文件职责：记录非审计来源需求问题；审计问题只记录索引。 +管理规范/模板：../../common/pro-doc/需求问题记录模版.md；需求规范.md。 +引用文件：需求审计报告.md；需求执行日志.md。 +记录方式：append-only 问题账本。 + +当前无非审计来源需求问题。 + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" new file mode 100644 index 0000000..9c1d0ff --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" @@ -0,0 +1,17 @@ +# 项目事项审计报告 + +创建人员：Codex +文件职责：记录项目事项计划审计、执行审计和复审结论。 +管理规范/模板：../common/project-doc/项目事项审计报告模版.md；../common/ai-workplace/AI工作空间创建指南.md。 +引用文件：项目事项总纲.md；项目事项计划.md；项目执行日志.md；项目配置清单.md。 +记录方式：append-only 审计账本；最新审计记录追加到末尾。 + +## AUDIT-AIWS-001：AI 工作空间创建校验审计 + +| 字段 | 内容 | +|---|---| +| 对应事项 | PROJECT-AIWS-001 | +| 审计范围 | ai-lena、ai-omar、项目配置清单、需求 / 开发目标目录、日志和变更 | +| 结论 | PASS | +| 说明 | 两个工作说明均列出对应体系规范、审核规范、账本入口和权限边界；无裸开发 AI、裸审核员或 target_workspace 待创建状态 | + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\346\200\273\347\272\262.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\346\200\273\347\272\262.md" new file mode 100644 index 0000000..bb02ea2 --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\346\200\273\347\272\262.md" @@ -0,0 +1,17 @@ +# 项目事项总纲 + +创建人员：Codex +文件职责：记录本项目项目级事项背景、目标、边界、状态和结论。 +管理规范/模板：../common/project-doc/项目事项总纲模版.md。 +引用文件：项目事项计划.md；项目执行日志.md；项目事项审计报告.md。 +记录方式：append-only 账本；最新事项追加到末尾。 + +## PROJECT-AIWS-001：AI 工作空间创建校验 + +| 字段 | 内容 | +|---|---| +| 来源 | 用户要求验证需求开发和需求开发审核工作说明是否满足新口径 | +| 目标 | 创建两个 AI 工作空间并按校验方案检查 | +| 范围 | 需求开发 AI、需求开发审核 AI、项目配置清单、日志和变更记录 | +| 状态 | 已执行，待审计 | + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" new file mode 100644 index 0000000..0c8b380 --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" @@ -0,0 +1,17 @@ +# 项目事项计划 + +创建人员：Codex +文件职责：记录项目事项计划、步骤、输入输出、验收方式和审计入口。 +管理规范/模板：../common/project-doc/项目事项计划模版.md。 +引用文件：项目事项总纲.md；项目执行日志.md；项目事项审计报告.md。 +记录方式：append-only 账本；最新计划追加到末尾。 + +## PLAN-AIWS-001：AI 工作空间创建校验计划 + +| 字段 | 内容 | +|---|---| +| 对应事项 | PROJECT-AIWS-001 | +| 步骤 | 启用需求体系；创建需求开发目标工作区；创建 ai-lena 和 ai-omar；更新配置清单；记录执行日志和变更；按校验方案检查 | +| 验收 | 工作说明包含对应需求/开发/审核规范；目标工作区存在；配置、日志、变更记录一致 | +| 审计入口 | 项目事项审计报告.md | + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" new file mode 100644 index 0000000..e658e83 --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" @@ -0,0 +1,15 @@ +# 项目变更记录 + +创建人员：Codex +文件职责：记录项目目录、配置、角色、权限和体系启用变更历史。 +管理规范/模板：../common/project-doc/项目变更记录模版.md。 +引用文件：项目配置清单.md；项目执行日志.md。 +记录方式：append-only 变更账本；最新变更追加到末尾。 + +| 时间 | 变更 ID | 变更内容 | 影响范围 | 执行人 | +|---|---|---|---|---| +| 2026-06-03 | CHANGE-AIWS-INIT | 初始化项目和默认开发体系 | 项目根目录；dev/；dev-doc/ | Codex | +| 2026-06-03 | CHANGE-AIWS-PRO-ENABLE | 启用需求体系 | pro-doc/；项目配置清单 | Codex | +| 2026-06-03 | CHANGE-AIWS-PRO-DEV-WORKSPACE | 创建需求开发目标工作区 | dev/pro-dev/；dev-doc/pro-doc/ | Codex | +| 2026-06-03 | CHANGE-AIWS-AI-ROLE-001 | 创建 Lena、Omar 工作空间并分配角色 | ai-lena/；ai-omar/；项目配置清单 | Codex | + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\346\200\273\350\247\210.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\346\200\273\350\247\210.md" new file mode 100644 index 0000000..64bbcdd --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\346\200\273\350\247\210.md" @@ -0,0 +1,26 @@ +# 项目总览 + +创建人员：Codex +文件职责：记录 AI 工作空间创建校验项目的基础信息、目标、周期、背景和关键入口。 +管理规范/模板：../common/project-doc/项目总览范本.md；../common/project-doc/项目环境创建指南.md。 +引用文件：项目规范.md；项目配置清单.md；项目执行日志.md；项目变更记录.md。 +记录方式：项目稳定信息；项目基础目标或启用体系变化时更新。 + +## 1. 基本信息 + +| 字段 | 内容 | +|---|---| +| 项目名称 | project-ai-workspace-check | +| 项目 ID | PROJECT-AI-WORKSPACE-CHECK | +| 创建时间 | 2026-06-03 | +| 项目管理员 | Codex | +| 当前阶段 | AI 工作空间创建规则验证 | + +## 2. 项目目标 + +验证 AI 工作空间创建指南能否正确创建需求开发 AI 和需求开发审核 AI，并让工作说明覆盖需求规范、开发规范和对应审核规范。 + +## 3. 范围 + +本项目只用于体系校验，不承载真实需求或真实代码交付。 + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" new file mode 100644 index 0000000..8b0d84d --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" @@ -0,0 +1,18 @@ +# 项目执行日志 + +创建人员：Codex +文件职责：记录项目执行关键节点、产物路径、偏离和自检。 +管理规范/模板：../common/project-doc/项目执行日志模版.md。 +引用文件：项目事项总纲.md；项目事项计划.md；项目事项审计报告.md；项目变更记录.md。 +记录方式：append-only 执行日志；最新记录追加到末尾。 + +## LOG-AIWS-001：创建需求开发和审核 AI 工作空间 + +| 字段 | 内容 | +|---|---| +| 时间 | 2026-06-03 | +| 对应事项 | PROJECT-AIWS-001 | +| 动作 | 创建需求体系、开发体系、需求开发目标工作区、ai-lena、ai-omar | +| 产物 | 项目配置清单.md；ai-lena/工作说明.md；ai-omar/工作说明.md | +| 自检 | 已按 AI 工作空间创建指南 6.1-6.6 校验 | + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\350\247\204\350\214\203.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\350\247\204\350\214\203.md" new file mode 100644 index 0000000..17547e9 --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\350\247\204\350\214\203.md" @@ -0,0 +1,16 @@ +# 项目规范 + +创建人员：Codex +文件职责：记录本项目必须遵守的本地项目规范和配置入口。 +管理规范/模板：../common/project-doc/项目规范.md。 +引用文件：项目总览.md；项目配置清单.md；项目执行日志.md；项目变更记录.md。 +记录方式：本地项目规范；如有本地补充规则，追加到本文。 + +## 1. 基本口径 + +本项目必须遵守 `../common/project-doc/项目规范.md` 和 `../全局规范.md`。 + +## 2. 本地补充 + +本项目用于 AI 工作空间创建校验。所有需求开发和需求开发审核角色必须按 `../common/ai-workplace/AI工作空间创建指南.md` 生成工作说明并通过校验。 + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" new file mode 100644 index 0000000..40fb387 --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -0,0 +1,55 @@ +# 项目配置清单 + +创建人员：Codex +文件职责：记录本项目启用体系、AI 角色、权限边界、工作空间、目录映射和核心文档入口，是项目当前配置事实源。 +管理规范/模板：../全局规范.md；../common/project-doc/项目配置清单模版.md；../common/ai-workplace/AI工作空间创建指南.md。 +引用文件：项目总览.md；项目规范.md；项目执行日志.md；项目变更记录.md；pro-doc/需求规范.md；dev-doc/编码规范.md。 +记录方式：项目配置清单；当前状态可覆盖更新，变更历史写入项目变更记录.md 和项目执行日志.md。 + +## 1. 项目基本配置 + +| 字段 | 内容 | +|---|---| +| 项目名称 | project-ai-workspace-check | +| 项目 ID | PROJECT-AI-WORKSPACE-CHECK | +| 项目根目录 | ./ | +| 项目管理员 | Codex | +| 创建时间 | 2026-06-03 | +| 当前状态 | 校验中 | + +## 2. 已启用体系 + +| 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | +|---|---|---|---|---|---|---| +| 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | CHANGE-AIWS-INIT | +| 需求体系 | 是 | pro-doc/ | ../common/pro-doc/需求规范.md；../common/pro-doc/需求规范.md | pro-doc/需求规范.md；pro-doc/需求规范.md；pro-doc/需求审核规范.md | 需求 AI；需求审核员 | CHANGE-AIWS-PRO-ENABLE | +| 开发体系 | 是 | dev/；dev-doc/；dev/pro-dev/；dev-doc/pro-doc/ | ../common/dev-doc/编码规范.md；../common/dev-doc/开发审计规范.md | dev-doc/编码规范.md；dev-doc/开发审计规范.md；dev-doc/pro-doc/开发工作区说明.md | 开发 AI；开发审核员 | CHANGE-AIWS-DEV-ENABLE；CHANGE-AIWS-PRO-DEV-WORKSPACE | + +## 3. AI 角色与权限 + +| AI 名称 | 角色 | 是否审核员 | 工作空间 | 默认写权限范围 | 备注 | +|---|---|---|---|---|---| +| Lena | 需求 AI；开发 AI（需求开发） | 否 | ai-lena/ | pro-doc/；dev/pro-dev/；dev/pro-dev/test/；dev-doc/pro-doc/；ai-lena/ | 需求开发组合角色，必须读需求规范和开发规范 | +| Omar | 审核员（需求审核；开发审核） | 是 | ai-omar/ | pro-doc/需求审计报告.md；dev-doc/开发审计报告.md；ai-omar/ | 需求-开发审核员，必须同时读需求、开发和各自审核规范 | + +## 4. 目录映射 + +| 目录 | 用途 | 负责人 / 角色 | 状态 | 备注 | +|---|---|---|---|---| +| pro-doc/ | 需求文档体系 | Lena；Omar | 已创建 | 需求体系已启用 | +| dev/ | 开发代码根目录 | Lena | 已创建 | 根级开发体系 | +| dev/pro-dev/ | 需求开发代码目录 | Lena | 已创建 | 需求开发目标工作区 | +| dev-doc/ | 开发账本和开发规范 | Lena；Omar | 已创建 | 根级开发账本 | +| dev-doc/pro-doc/ | 需求开发目标文档区 | Lena | 已创建 | 不复制第二套开发账本 | +| ai-lena/ | AI 工作空间 | Lena | 已创建 | 需求开发 AI | +| ai-omar/ | AI 工作空间 | Omar | 已创建 | 需求开发审核 AI | + +## 5. 变更索引 + +| 时间 | 变更记录 ID | 变更摘要 | 执行人 | +|---|---|---|---| +| 2026-06-03 | CHANGE-AIWS-INIT | 初始化项目和默认开发体系 | Codex | +| 2026-06-03 | CHANGE-AIWS-PRO-ENABLE | 启用需求体系 | Codex | +| 2026-06-03 | CHANGE-AIWS-PRO-DEV-WORKSPACE | 创建需求开发目标工作区 | Codex | +| 2026-06-03 | CHANGE-AIWS-AI-ROLE-001 | 创建 Lena、Omar 工作空间并分配需求开发 / 需求开发审核角色 | Codex | + diff --git "a/project-ai-workspace-check/\351\241\271\347\233\256\351\227\256\351\242\230\350\256\260\345\275\225.md" "b/project-ai-workspace-check/\351\241\271\347\233\256\351\227\256\351\242\230\350\256\260\345\275\225.md" new file mode 100644 index 0000000..3c1cdaa --- /dev/null +++ "b/project-ai-workspace-check/\351\241\271\347\233\256\351\227\256\351\242\230\350\256\260\345\275\225.md" @@ -0,0 +1,10 @@ +# 项目问题记录 + +创建人员：Codex +文件职责：记录非审计来源项目级问题、影响、修复建议和复验状态。 +管理规范/模板：../common/project-doc/项目问题记录模版.md。 +引用文件：项目事项审计报告.md；项目执行日志.md。 +记录方式：append-only 问题账本；审计问题主记录写入审计报告。 + +当前无非审计来源问题。 + diff --git "a/project-d/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/project-d/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" index f969a2e..389036e 100644 --- "a/project-d/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" +++ "b/project-d/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -22,7 +22,7 @@ | 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | |---|---|---|---|---|---|---| | 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | CHANGE-PROJD-INIT | -| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 产品 AI | | +| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 需求 AI | | | 开发体系 | 是 | dev/；dev/test/；dev/tmp/；dev-doc/；目标开发工作区按需创建 | ../common/dev-doc/开发环境创建指南.md；../common/dev-doc/编码规范.md；../common/dev-doc/开发审计规范.md | dev-doc/目录导读.md；dev-doc/编码规范.md；dev-doc/开发审计规范.md；dev-doc/开发事项总纲.md；dev-doc/开发事项计划.md；dev-doc/开发执行日志.md；dev-doc/开发审计报告.md；dev-doc/开发问题记录.md；重型开发方案按事项创建到开发方案目录；目标开发工作区创建后登记 | 开发 AI | CHANGE-PROJD-DEV-ROOT-DEFAULT | | 实验体系 | 是 | exp-doc/；exp-data/ | ../common/exp-doc/实验规范.md；../common/exp-doc/实验审核规范.md | exp-doc/实验规范.md；exp-doc/实验审计规范.md | 实验员 | CHANGE-PROJD-EXP-HEAVY-ENABLE | | 案例分析体系 | 否 | ana-doc/；ana-data/ | ../common/ana-doc/案例分析规范.md | ana-doc/案例分析规范.md | 案例分析员 | | @@ -41,7 +41,7 @@ | 角色 | 默认写权限目录 | 说明 | |---|---|---| | 项目管理员 | 项目根目录 | 管理项目规范、项目配置清单、项目级账本和体系启用 | -| 产品 AI | pro-doc/ | 需求、产品、策略文档 | +| 需求 AI | pro-doc/ | 需求、策略文档 | | 开发 AI | dev/<target>-dev/；dev/<target>-dev/test/；dev-doc/<target>-doc/ | 代码、测试、目标代码文档和方案附件；正式开发账本统一在 dev-doc/ 根目录 | | 实验员 | exp-doc/；exp-data/ | 实验文档、实验数据、结果包 | | 案例分析员 | ana-doc/；ana-data/ | 案例分析文档、案例数据、图片 | diff --git "a/project-e/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/project-e/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" index 0e6ea6e..340b681 100644 --- "a/project-e/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" +++ "b/project-e/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -22,7 +22,7 @@ | 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | |---|---|---|---|---|---|---| | 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | CHANGE-PROJE-INIT | -| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 产品 AI | | +| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 需求 AI | | | 开发体系 | 是 | dev/；dev/test/；dev/tmp/；dev-doc/；dev/project-dev/；dev-doc/project-doc/ | ../common/dev-doc/开发环境创建指南.md；../common/dev-doc/编码规范.md；../common/dev-doc/开发审计规范.md | dev-doc/目录导读.md；dev-doc/编码规范.md；dev-doc/开发审计规范.md；dev-doc/开发事项总纲.md；dev-doc/开发事项计划.md；dev-doc/开发执行日志.md；dev-doc/开发审计报告.md；dev-doc/开发问题记录.md；dev-doc/project-doc/目录导读.md；dev-doc/project-doc/开发工作区说明.md | 开发 AI | CHANGE-PROJE-INIT；CHANGE-PROJE-AI-WORKPLACE-001 | | 实验体系 | 否 | exp-doc/；exp-data/ | ../common/exp-doc/实验规范.md | exp-doc/实验规范.md | 实验员 | | | 案例分析体系 | 否 | ana-doc/；ana-data/ | ../common/ana-doc/案例分析规范.md | ana-doc/案例分析规范.md | 案例分析员 | | diff --git "a/project-g/ai-morgan/worklog/20260603_\345\267\245\344\275\234\350\257\264\346\230\216\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" "b/project-g/ai-morgan/worklog/20260603_\345\267\245\344\275\234\350\257\264\346\230\216\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" index cc74c9e..86e6566 100644 --- "a/project-g/ai-morgan/worklog/20260603_\345\267\245\344\275\234\350\257\264\346\230\216\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" +++ "b/project-g/ai-morgan/worklog/20260603_\345\267\245\344\275\234\350\257\264\346\230\216\351\246\226\346\254\241\351\230\205\350\257\273\345\217\215\351\246\210.md" @@ -1,4 +1,4 @@ -# Morgan 工作说明首次阅读反馈 +# Morgan 工作说明首次阅读反馈 记录人员：Codex 模拟 Morgan 记录时间：2026-06-03 @@ -6,9 +6,9 @@ ## 1. 角色理解 -已理解当前角色是 `产品 AI（需求/产品草案）`、`审核员（项目事项审核）` 和 `审核员（实验审核）`。 +已理解当前角色是 `需求 AI（需求草案）`、`审核员（项目事项审核）` 和 `审核员（实验审核）`。 -需求体系未启用，产品内容只能写 `ai-morgan/draft/`。 +需求体系未启用，需求内容只能写 `ai-morgan/draft/`。 ## 2. 必读文档 @@ -16,7 +16,7 @@ - 项目事项审核：`项目规范.md`、`项目事项总纲.md`、`项目事项计划.md`、`项目执行日志.md`、`项目变更记录.md`、`项目问题记录.md`、`项目事项审计报告.md` - 实验审核：`exp-doc/实验规范.md`、`exp-doc/实验审计规范.md`、`exp-doc/实验总纲.md`、`exp-doc/实验设计.md`、`exp-doc/实验执行日志.md`、`exp-doc/实验问题记录.md`、`exp-doc/实验审计报告.md` -- 产品草案：`common/pro-doc/需求规范.md`、`项目配置清单.md` +- 需求草案：`common/pro-doc/需求规范.md`、`项目配置清单.md` ## 3. 疑问 / 不合理点 @@ -24,4 +24,4 @@ ## 4. 结论 -可按工作说明进入项目事项审核、实验审核和产品草案工作。 +可按工作说明进入项目事项审核、实验审核和需求草案工作。 diff --git "a/project-g/ai-morgan/\345\267\245\344\275\234\350\257\264\346\230\216.md" "b/project-g/ai-morgan/\345\267\245\344\275\234\350\257\264\346\230\216.md" index 0cb223e..b5bf4ba 100644 --- "a/project-g/ai-morgan/\345\267\245\344\275\234\350\257\264\346\230\216.md" +++ "b/project-g/ai-morgan/\345\267\245\344\275\234\350\257\264\346\230\216.md" @@ -1,4 +1,4 @@ -# Morgan 工作说明 +# Morgan 工作说明 创建人员：Codex 文件职责：记录 Morgan 在 Project G 中的角色入口、职责边界、权限范围和体系文档路由。 @@ -15,13 +15,13 @@ | 工作空间 | ai-morgan/ | | 指派人 | Codex | | 指派时间 | 2026-06-03 | -| 指派原因 | 验证 AI 工作空间创建指南能支持产品/审核组合角色，并验证未启用体系的权限降级口径 | +| 指派原因 | 验证 AI 工作空间创建指南能支持需求/审核组合角色，并验证未启用体系的权限降级口径 | ## 2. 当前角色 | 角色 | 职责边界 | 正式写权限 | 必读入口 | |---|---|---|---| -| 产品 AI（需求/产品草案） | 编写需求、产品、策略或业务规则草案 | 需求体系未启用，只能写 `ai-morgan/draft/`；不得写 `pro-doc/` | `../../common/pro-doc/需求规范.md`；`../项目配置清单.md` | +| 需求 AI（需求草案） | 编写需求、策略或业务规则草案 | 需求体系未启用，只能写 `ai-morgan/draft/`；不得写 `pro-doc/` | `../../common/pro-doc/需求规范.md`；`../项目配置清单.md` | | 审核员（项目事项审核） | 审核项目事项计划、执行证据链、项目变更和项目事项结果 | `项目事项审计报告.md`；`ai-morgan/` | `../项目规范.md`；`../项目事项总纲.md`；`../项目事项计划.md`；`../项目执行日志.md`；`../项目变更记录.md`；`../项目问题记录.md`；`../项目事项审计报告.md` | | 审核员（实验审核） | 审核实验设计、实验执行日志、结果包和实验结论 | `exp-doc/实验审计报告.md`；`ai-morgan/` | `../exp-doc/实验规范.md`；`../exp-doc/实验审计规范.md`；`../exp-doc/实验总纲.md`；`../exp-doc/实验设计.md`；`../exp-doc/实验执行日志.md`；`../exp-doc/实验问题记录.md`；`../exp-doc/实验审计报告.md` | @@ -32,7 +32,7 @@ | 项目基础 | `../项目配置清单.md`；`../项目规范.md` | 确认角色、权限、已启用体系和项目规则 | | 项目事项审核 | `../项目规范.md`；`../项目事项总纲.md`；`../项目事项计划.md`；`../项目执行日志.md`；`../项目变更记录.md`；`../项目问题记录.md`；`../项目事项审计报告.md` | 同时理解项目事项怎么做、证据链在哪、审计意见写哪 | | 实验审核 | `../exp-doc/实验规范.md`；`../exp-doc/实验审计规范.md`；`../exp-doc/实验总纲.md`；`../exp-doc/实验设计.md`；`../exp-doc/实验执行日志.md`；`../exp-doc/实验问题记录.md`；`../exp-doc/实验审计报告.md` | 同时理解实验怎么做、怎么审、证据链在哪 | -| 产品草案 | `../../common/pro-doc/需求规范.md`；`../项目配置清单.md` | 需求体系未启用时只做草案，不进入正式目录 | +| 需求草案 | `../../common/pro-doc/需求规范.md`；`../项目配置清单.md` | 需求体系未启用时只做草案，不进入正式目录 | ## 4. 目录入口 @@ -40,7 +40,7 @@ | 路径 | 用途 | |---|---| -| `ai-morgan/draft/` | 私有草稿，当前产品内容只能写这里 | +| `ai-morgan/draft/` | 私有草稿，当前需求内容只能写这里 | | `ai-morgan/tmp/` | 私有临时文件 | | `ai-morgan/worklog/` | 私有过程记录，不能替代正式审计报告 | | `项目事项审计报告.md` | 项目事项审核入口 | @@ -48,8 +48,8 @@ ## 5. 任务入口路由 -1. 接到任务后，先查 `../项目配置清单.md`，确认任务属于产品草案、项目事项审核或实验审核。 -2. 产品任务因需求体系未启用，只能写 `ai-morgan/draft/`，不得写正式 `pro-doc/`。 +1. 接到任务后，先查 `../项目配置清单.md`，确认任务属于需求草案、项目事项审核或实验审核。 +2. 需求任务因需求体系未启用，只能写 `ai-morgan/draft/`，不得写正式 `pro-doc/`。 3. 项目事项审核必须同时读取项目规范、项目事项账本、执行日志、变更记录、问题记录和审计报告。 4. 实验审核必须同时读取实验规范、实验审计规范、实验总纲、实验设计、实验执行日志、实验问题记录和实验审计报告。 5. 工作说明只提供入口；具体流程、日志和审计要求以对应体系文档为准。 diff --git "a/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" "b/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" index 941b761..8850dce 100644 --- "a/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" +++ "b/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\345\256\241\350\256\241\346\212\245\345\221\212.md" @@ -1,4 +1,4 @@ -# 项目事项审计报告 +# 项目事项审计报告 创建人员：Codex 文件职责：记录 Project G 项目事项计划审计、执行审计和复审结论。 @@ -31,7 +31,7 @@ | 未创建裸 AI 名目录 | PASS | 未发现 `Andrew/` 或 `Morgan/` | | 项目配置清单已更新 | PASS | AI 角色与权限、目录映射、变更索引均已记录 | | 工作说明与配置一致 | PASS | Andrew、Morgan 的角色和权限与配置清单一致 | -| 未启用体系未越权 | PASS | Morgan 产品角色只能写草稿，不写 `pro-doc/` | +| 未启用体系未越权 | PASS | Morgan 需求角色只能写草稿，不写 `pro-doc/` | | 开发 target 未越权 | PASS | Andrew 开发角色未绑定 target，正式开发写权限暂不生效 | | 项目日志和变更已记录 | PASS | 项目执行日志和项目变更记录已写入 | | 项目事项链已记录 | PASS | 项目事项总纲和项目事项计划已记录 PROJECT-G-AI-WORKPLACE-001 | @@ -40,7 +40,7 @@ 站在被指派 AI 视角复核： 1. Andrew 能知道自己负责实验执行和实验相关开发，但开发正式写入必须等 target_workspace 创建。 2. Andrew 能知道正式实验产物放 `exp-doc/`、`exp-data/`，工作空间只放草稿和临时文件。 -3. Morgan 能知道自己是产品 AI 和审核员，但需求体系未启用，产品内容只能先写草稿。 +3. Morgan 能知道自己是需求 AI 和审核员，但需求体系未启用，需求内容只能先写草稿。 4. Morgan 能知道审计意见写对应审计报告，不能直接改被审计主产物。 发现问题：无。 @@ -98,7 +98,7 @@ | Andrew 开发目标工作区 | PASS | 后续已创建 `dev/exp-dev/` 和 `dev-doc/exp-doc/`，正式实验开发写权限生效 | | Morgan 审核角色范围 | PASS | 已明确为“审核员（项目事项审核；实验审核）” | | Morgan 审计入口 | PASS | 分别绑定 `项目事项审计报告.md` 和 `exp-doc/实验审计报告.md` | -| Morgan 产品权限降级 | PASS | 需求体系未启用，产品内容只能写 `ai-morgan/draft/` | +| Morgan 需求权限降级 | PASS | 需求体系未启用，需求内容只能写 `ai-morgan/draft/` | | 裸角色残留 | PASS | 正式配置和工作说明中不再用裸“开发 AI”或裸“审核员”落地权限 | 发现问题：无。 diff --git "a/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" "b/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" index fb8e74d..403730a 100644 --- "a/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" +++ "b/project-g/\351\241\271\347\233\256\344\272\213\351\241\271\350\256\241\345\210\222.md" @@ -1,4 +1,4 @@ -# 项目事项计划 +# 项目事项计划 创建人员：Codex 文件职责：记录 Project G 项目事项计划、步骤、输入输出和验收方式。 @@ -24,7 +24,7 @@ 步骤： 1. 创建 `ai-andrew/` 和 `ai-morgan/` 工作空间及 `tmp/`、`draft/`、`worklog/` 子目录。 2. 为 Andrew 指派“实验员；开发 AI（实验开发）”角色，并同步创建实验开发目标工作区。 -3. 为 Morgan 指派“产品 AI（需求/产品草案）；审核员（项目事项审核；实验审核）”角色。 +3. 为 Morgan 指派“需求 AI（需求草案）；审核员（项目事项审核；实验审核）”角色。 4. 分别生成 `工作说明.md`。 5. 更新 `项目配置清单.md` 的 AI 角色、权限、目录映射和变更索引。 6. 写入项目执行日志和项目变更记录。 diff --git "a/project-g/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" "b/project-g/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" index aa56b64..04bdcee 100644 --- "a/project-g/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" +++ "b/project-g/\351\241\271\347\233\256\345\217\230\346\233\264\350\256\260\345\275\225.md" @@ -1,4 +1,4 @@ -# 项目变更记录 +# 项目变更记录 创建人员：Codex 文件职责：记录 Project G 的目录、配置、角色、权限和体系启用变化。 @@ -24,7 +24,7 @@ 变更类型：AI 工作空间创建 / 角色指派 / 项目配置清单更新。 变更内容： 1. 新增 `ai-andrew/` 工作空间，指派角色：实验员；开发 AI。 -2. 新增 `ai-morgan/` 工作空间，指派角色：产品 AI；审核员。 +2. 新增 `ai-morgan/` 工作空间，指派角色：需求 AI；审核员。 3. 生成 `ai-andrew/工作说明.md` 和 `ai-morgan/工作说明.md`。 4. 升级 `项目配置清单.md`，补齐 AI 角色与权限、默认角色权限、目录映射、核心入口和变更索引。 关联日志：LOG-PROJECT-G-AI-WORKPLACE-001。 @@ -38,7 +38,7 @@ 变更内容： 1. Andrew 的开发角色补充体系范围，固定为实验开发，目标工作区为 `dev/exp-dev/` 和 `dev-doc/exp-doc/`。 2. Morgan 的审核角色拆成项目事项审核和实验审核，分别绑定 `项目事项审计报告.md` 和 `exp-doc/实验审计报告.md`。 -3. Morgan 的产品角色降级为需求/产品草案角色；需求体系未启用时不得写正式 `pro-doc/`。 +3. Morgan 的需求角色降级为需求草案角色；需求体系未启用时不得写正式 `pro-doc/`。 关联日志：LOG-PROJECT-G-AI-ROLE-SCOPE-FIX。 影响：消除“开发 AI”和“审核员”裸角色带来的权限边界歧义；不新增目录，不改变已启用体系。 当前状态：已修正，待复审。 diff --git "a/project-g/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" "b/project-g/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" index 4aab518..cee6aa6 100644 --- "a/project-g/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" +++ "b/project-g/\351\241\271\347\233\256\346\211\247\350\241\214\346\227\245\345\277\227.md" @@ -1,4 +1,4 @@ -# 项目执行日志 +# 项目执行日志 创建人员：Codex 文件职责：记录 Project G 项目事项执行过程、关键节点、目录、文档和偏离。 @@ -39,9 +39,9 @@ 执行目标：修正 AI 角色指派中的裸角色口径，明确开发角色和审核角色必须绑定具体体系。 修正内容： 1. `项目配置清单.md` 中 Andrew 从“实验员；开发 AI”修正为“实验员；开发 AI（实验开发）”，并要求同步创建实验开发目标工作区。 -2. `项目配置清单.md` 中 Morgan 从“产品 AI；审核员”修正为“产品 AI（需求/产品草案）；审核员（项目事项审核；实验审核）”。 +2. `项目配置清单.md` 中 Morgan 从“需求 AI；审核员”修正为“需求 AI（需求草案）；审核员（项目事项审核；实验审核）”。 3. `ai-andrew/工作说明.md` 明确实验开发目标目录为 `dev/exp-dev/` 和 `dev-doc/exp-doc/`。 -4. `ai-morgan/工作说明.md` 明确 Morgan 只承担项目事项审核和实验审核，当前不承担开发审核；需求体系未启用时产品内容只能写草稿。 +4. `ai-morgan/工作说明.md` 明确 Morgan 只承担项目事项审核和实验审核，当前不承担开发审核；需求体系未启用时需求内容只能写草稿。 自检结果：不再存在裸“开发 AI”或裸“审核员”作为正式落地角色；角色范围与项目配置清单一致。 状态：PASS。 @@ -113,10 +113,10 @@ 2. `ai-morgan/工作说明.md`。 配置变更： 1. `项目配置清单.md` 新增 Andrew：实验员；开发 AI。 -2. `项目配置清单.md` 新增 Morgan：产品 AI；审核员。 +2. `项目配置清单.md` 新增 Morgan：需求 AI；审核员。 3. `项目配置清单.md` 增加 `ai-andrew/`、`ai-morgan/` 目录映射和变更索引。 注意事项： -1. Morgan 的产品 AI 角色因 Project G 未启用需求体系，正式 `pro-doc/` 写权限不生效，只能写 `ai-morgan/draft/`。 +1. Morgan 的需求 AI 角色因 Project G 未启用需求体系，正式 `pro-doc/` 写权限不生效，只能写 `ai-morgan/draft/`。 2. Andrew 的开发 AI 角色当前未绑定具体 target，正式开发写权限暂不生效；后续必须先按开发环境创建指南创建 target_workspace。 自检结果：按 AI 工作空间创建指南校验通过；工作空间、工作说明、配置清单、日志、变更记录和审计链路均已对齐。 状态：PASS。 diff --git "a/project-g/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/project-g/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" index 9a2ad99..0f10c63 100644 --- "a/project-g/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" +++ "b/project-g/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -1,4 +1,4 @@ -# 项目配置清单 +# 项目配置清单 创建人员：Codex 文件职责：记录 Project G 当前启用体系、AI 角色、权限边界、工作空间、目录映射和核心文档入口，是项目当前配置的事实源。 @@ -22,7 +22,7 @@ | 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | |---|---|---|---|---|---|---| | 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | CHANGE-PROJECT-G-INIT | -| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 产品 AI | | +| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 需求 AI | | | 开发体系 | 是 | dev/；dev/test/；dev/tmp/；dev-doc/；dev/exp-dev/；dev-doc/exp-doc/ | ../common/dev-doc/开发环境创建指南.md；../common/dev-doc/编码规范.md；../common/dev-doc/开发审计规范.md | dev-doc/目录导读.md；dev-doc/编码规范.md；dev-doc/开发审计规范.md；dev-doc/开发事项总纲.md；dev-doc/开发事项计划.md；dev-doc/开发执行日志.md；dev-doc/开发审计报告.md；dev-doc/开发问题记录.md；dev-doc/exp-doc/目录导读.md；dev-doc/exp-doc/开发工作区说明.md | 开发 AI | CHANGE-PROJECT-G-INIT；CHANGE-PROJECT-G-EXP-DEV-WORKSPACE-001 | | 实验体系 | 是 | exp-doc/；exp-data/ | ../common/exp-doc/实验规范.md；../common/exp-doc/实验审核规范.md | exp-doc/实验规范.md；exp-doc/实验审计规范.md | 实验员 | CHANGE-PROJECT-G-INIT | | 案例分析体系 | 否 | ana-doc/；ana-data/ | ../common/ana-doc/案例分析规范.md | ana-doc/案例分析规范.md | 案例分析员 | | @@ -36,14 +36,14 @@ |---|---|---|---|---|---| | Codex | 项目管理员；审核员（项目事项审核） | 是 | ai-codex/ | 项目根目录；ai-codex/；项目事项审计报告.md | 负责项目创建和本轮校验 | | Andrew | 实验员；开发 AI（实验开发） | 否 | ai-andrew/ | exp-doc/；exp-data/；ai-andrew/；dev/exp-dev/；dev/exp-dev/test/；dev-doc/exp-doc/ | 实验开发 target_workspace 已创建，正式开发写权限生效 | -| Morgan | 产品 AI（需求/产品草案）；审核员（项目事项审核；实验审核） | 是 | ai-morgan/ | ai-morgan/；项目事项审计报告.md；exp-doc/实验审计报告.md；需求体系未启用，产品正式写权限暂不生效 | 产品草案只能写 ai-morgan/draft/；不得写 pro-doc/ | +| Morgan | 需求 AI（需求草案）；审核员（项目事项审核；实验审核） | 是 | ai-morgan/ | ai-morgan/；项目事项审计报告.md；exp-doc/实验审计报告.md；需求体系未启用，需求正式写权限暂不生效 | 需求草案只能写 ai-morgan/draft/；不得写 pro-doc/ | ## 4. 默认角色权限 | 角色 | 默认写权限目录 | 说明 | |---|---|---| | 项目管理员 | 项目根目录 | 管理项目规范、项目配置清单、项目级账本和体系启用 | -| 产品 AI | pro-doc/ | 需求、产品、策略文档；需求体系未启用时只能写工作空间草稿 | +| 需求 AI | pro-doc/ | 需求、策略文档；需求体系未启用时只能写工作空间草稿 | | 开发 AI（指定体系开发） | dev/<target>-dev/；dev/<target>-dev/test/；dev-doc/<target>-doc/ | 代码、测试、目标代码文档和方案附件；正式开发账本统一在 dev-doc/ 根目录 | | 实验员 | exp-doc/；exp-data/ | 实验文档、实验数据、结果包 | | 案例分析员 | ana-doc/；ana-data/ | 案例分析文档、案例数据、图片 | diff --git "a/wuji-trade/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" "b/wuji-trade/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" index a85908f..c2cf8fa 100644 --- "a/wuji-trade/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" +++ "b/wuji-trade/\351\241\271\347\233\256\351\205\215\347\275\256\346\270\205\345\215\225.md" @@ -1,4 +1,4 @@ -# 项目配置清单 +# 项目配置清单 创建人员：Codex 文件职责：记录 wuji-trade 当前启用体系、AI 角色、权限边界、工作空间、目录映射和核心文档入口，是项目当前配置的事实源。 @@ -23,7 +23,7 @@ | 体系 | 是否启用 | 目录 | common 规范 | 本地规范 | 适用角色 | 最近变更记录 | |---|---|---|---|---|---|---| | 项目体系 | 是 | ./ | ../common/project-doc/项目规范.md | 项目规范.md | 项目管理员 | CHANGE-WUJI-INIT | -| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 产品 AI | | +| 需求体系 | 否 | pro-doc/ | ../common/pro-doc/需求规范.md | pro-doc/需求规范.md | 需求 AI | | | 开发体系 | 是 | dev/；dev/test/；dev/tmp/；dev-doc/ | ../common/dev-doc/开发环境创建指南.md；../common/dev-doc/编码规范.md；../common/dev-doc/开发审计规范.md | dev-doc/目录导读.md；dev-doc/编码规范.md；dev-doc/开发审计规范.md；dev-doc/开发事项总纲.md；dev-doc/开发事项计划.md；dev-doc/开发执行日志.md；dev-doc/开发审计报告.md；dev-doc/开发问题记录.md | 开发 AI | CHANGE-WUJI-INIT | | 实验体系 | 是 | exp-doc/；exp-data/ | ../common/exp-doc/实验规范.md；../common/exp-doc/实验审核规范.md | exp-doc/实验规范.md；exp-doc/实验审计规范.md | 实验员 | CHANGE-WUJI-INIT | | 案例分析体系 | 是 | ana-doc/；ana-data/ | ../common/ana-doc/案例分析规范.md；../common/ana-doc/案例审核规范.md | ana-doc/案例分析规范.md；ana-doc/案例审核规范.md | 案例分析员 | CHANGE-WUJI-INIT | @@ -42,7 +42,7 @@ | 角色 | 默认写权限目录 | 说明 | |---|---|---| | 项目管理员 | 项目根目录 | 管理项目规范、项目配置清单、项目级账本和体系启用 | -| 产品 AI | pro-doc/ | 需求、产品、策略文档；需求体系未启用时只能写工作空间草稿 | +| 需求 AI | pro-doc/ | 需求、策略文档；需求体系未启用时只能写工作空间草稿 | | 开发 AI（指定体系开发） | dev/<target>-dev/；dev/<target>-dev/test/；dev-doc/<target>-doc/ | 代码、测试、目标代码文档和方案附件；正式开发账本统一在 dev-doc/ 根目录 | | 实验员 | exp-doc/；exp-data/ | 实验文档、实验数据、结果包 | | 案例分析员 | ana-doc/；ana-data/ | 案例分析文档、案例数据、图片 | diff --git "a/\344\275\223\347\263\273\345\210\233\345\273\272\346\265\201\347\250\213.md" "b/\344\275\223\347\263\273\345\210\233\345\273\272\346\265\201\347\250\213.md" index a0cf8c6..164a56f 100644 --- "a/\344\275\223\347\263\273\345\210\233\345\273\272\346\265\201\347\250\213.md" +++ "b/\344\275\223\347\263\273\345\210\233\345\273\272\346\265\201\347\250\213.md" @@ -1,4 +1,4 @@ -# 体系创建流程 +# 体系创建流程 创建人员：Codex 文件职责：说明如何创建一个新的通用体系，并保留体系组件的核心目标、原则、模板、创建指南和审计闭环。 @@ -14,7 +14,7 @@ 1. 项目体系。 2. 实验体系。 -3. 产品体系。 +3. 需求体系。 4. 开发体系。 5. 数据体系。 6. 案例分析体系。 diff --git "a/\344\275\223\347\263\273\345\267\256\345\274\202.md" "b/\344\275\223\347\263\273\345\267\256\345\274\202.md" index 84e3c5b..b8ac915 100644 --- "a/\344\275\223\347\263\273\345\267\256\345\274\202.md" +++ "b/\344\275\223\347\263\273\345\267\256\345\274\202.md" @@ -1,8 +1,8 @@ -#体系差异 +#体系差异 ##现有体系说明 1.开发体系 -2.产品体系 +2.需求体系 3.实验体系 4.项目体系 5.案例分析体系 @@ -15,10 +15,10 @@ -- 开发体系的存储体系很简单，主要产出代码、测试、编码方案、开发日志、审计报告和问题记录；通常没有实验结果包和大量数据资产。 -- 开发体系的问题文档主要记录非审计来源问题，例如需求 AI、实验员、案例分析员或人工验收反馈；开发审核员发现的问题主记录写开发审计报告。 -- 开发体系比实验体系轻，不需要实验数据归档体系，但必须保留代码、测试、执行日志和审计证据链。 -3. 产品体系和实验体系的差异： --- 产品体系主要产出产品、需求、策略、业务规则文档，存储体系很轻，通常没有结果包和大量数据资产。 --- 产品体系的问题文档主要记录非审计来源的产品/需求问题，例如开发员看需求时发现字段、边界、验收不清。 --- 产品体系如果需要代码实现，不把代码放进 `pro-doc/`，而是进入开发体系的产品开发目录：`dev/pro-dev/`、`dev/pro-dev/test/`、`dev-doc/pro-doc/`。 +3. 需求体系和实验体系的差异： +-- 需求体系主要产出需求、策略、业务规则文档，存储体系很轻，通常没有结果包和大量数据资产。 +-- 需求体系的问题文档主要记录非审计来源的需求问题，例如开发员看需求时发现字段、边界、验收不清。 +-- 需求体系如果需要代码实现，不把代码放进 `pro-doc/`，而是进入开发体系的需求开发目录：`dev/pro-dev/`、`dev/pro-dev/test/`、`dev-doc/pro-doc/`。 @@ -31,8 +31,8 @@ /dev-doc/<target>-doc：对应目标体系的编码方案、测试说明、开发审计材料 开发体系绑定其他体系或目标事项，不建议把代码直接放在 /dev 根目录。 -2.产品体系 -/pro-doc: 存放所有的产品文档 +2.需求体系 +/pro-doc: 存放所有的需求文档 具体文件夹里子文件夹还需要如何分类，具体按业务来 3.实验体系 /exp-doc：存放所有的实验文档 diff --git "a/\344\275\223\347\263\273\350\257\264\346\230\216.md" "b/\344\275\223\347\263\273\350\257\264\346\230\216.md" index 9e35e9a..2005d25 100644 --- "a/\344\275\223\347\263\273\350\257\264\346\230\216.md" +++ "b/\344\275\223\347\263\273\350\257\264\346\230\216.md" @@ -1,9 +1,9 @@ -# 体系说明 +# 体系说明 创建人员：Codex 文件职责：说明 AI 管理体系的总体结构、核心流程、关键文档、关键角色和审计闭环。 管理规范/模板：管理体系总说明文档；用于解释 `管理体系说明.vsdx` 的文字含义。 -引用文件：管理系统说明.md；管理体系说明.vsdx；全局规范.md；common/pro-doc/产品规范.md；common/pro-doc/需求规范.md；common/dev-doc/编码规范.md；common/exp-doc/实验规范.md。 +引用文件：管理系统说明.md；管理体系说明.vsdx；全局规范.md；common/pro-doc/需求规范.md；common/pro-doc/需求规范.md；common/dev-doc/编码规范.md；common/exp-doc/实验规范.md。 ## 1. 体系定位 @@ -215,7 +215,7 @@ 当前规划： -1. `pro-doc/`：产品、策略、需求相关规范。 +1. `pro-doc/`：需求、策略、需求相关规范。 2. `dev-doc/`：开发体系、编码、测试、自检相关规范。开发体系默认随项目创建，但开发必须绑定目标体系或目标事项；代码按 `dev/<target>-dev/` 分账，开发文档按 `dev-doc/<target>-doc/` 分账。 3. `exp-doc/`：实验体系规范和实验文档模板，包括实验总纲、实验设计、执行日志、实验存储体系创建指南、实验审核规范、审计报告、问题记录。项目内应创建本地 `实验规范.md` 和 `实验审计规范.md`，分别引用 common 全局规范。 4. `data-doc/`：数据存储、数据样本、数据库表、图片资产相关规范。 @@ -287,7 +287,7 @@ 开发体系不单独承载业务目标，它必须绑定其他体系或目标事项。常见绑定关系： -1. 产品开发：实现产品体系产出的产品需求、正式需求和业务规则。 +1. 需求开发：实现需求体系产出的需求、正式需求和业务规则。 2. 实验开发：实现实验脚本、数据处理、回测、图表、校验工具。 3. 案例分析开发：实现案例图表、账本、回放、审计辅助工具。 4. 项目工具开发：实现项目初始化、索引、检查、归档工具。 @@ -300,7 +300,7 @@ 例如： -1. 产品开发：`dev/pro-dev/`，`dev/pro-dev/test/`，`dev-doc/pro-doc/`。 +1. 需求开发：`dev/pro-dev/`，`dev/pro-dev/test/`，`dev-doc/pro-doc/`。 2. 实验开发：`dev/exp-dev/`，`dev/exp-dev/test/`，`dev-doc/exp-doc/`。 3. 案例分析开发：`dev/ana-dev/`，`dev/ana-dev/test/`，`dev-doc/ana-doc/`。 @@ -383,19 +383,19 @@ 1. `体系创建流程.md` 2. `pro-doc/目录导读.md` -3. `pro-doc/产品规范.md` -4. `pro-doc/产品环境创建指南.md` -5. `pro-doc/产品审核规范.md` +3. `pro-doc/需求规范.md` +4. `pro-doc/需求环境创建指南.md` +5. `pro-doc/需求审核规范.md` 6. `pro-doc/需求规范.md` -7. `pro-doc/产品总纲模版.md` -8. `pro-doc/产品设计模版.md` -9. `pro-doc/产品方案文档范本.md` -10. `pro-doc/产品架构文档范本.md` -11. `pro-doc/产品模块说明文档范本.md` -12. `pro-doc/产品核心流程文档范本.md` -13. `pro-doc/产品执行日志模版.md` -14. `pro-doc/产品审计报告模版.md` -15. `pro-doc/产品问题记录模版.md` +7. `pro-doc/需求总纲模版.md` +8. `pro-doc/需求设计模版.md` +9. `pro-doc/需求方案文档范本.md` +10. `pro-doc/需求架构文档范本.md` +11. `pro-doc/需求模块说明文档范本.md` +12. `pro-doc/需求核心流程文档范本.md` +13. `pro-doc/需求执行日志模版.md` +14. `pro-doc/需求审计报告模版.md` +15. `pro-doc/需求问题记录模版.md` 16. `pro-doc/需求文档范本.md` 17. `dev-doc/目录导读.md` 18. `dev-doc/编码规范.md` diff --git "a/\345\205\250\345\261\200\350\247\204\350\214\203.md" "b/\345\205\250\345\261\200\350\247\204\350\214\203.md" index ade01ae..6ed910b 100644 --- "a/\345\205\250\345\261\200\350\247\204\350\214\203.md" +++ "b/\345\205\250\345\261\200\350\247\204\350\214\203.md" @@ -3,7 +3,7 @@ 创建人员：Codex 文件职责：记录管理体系下所有项目、所有 AI、所有事项默认遵守的全局规则。 管理规范/模板：参考 `管理系统说明.md` 和 `体系说明.md`；本文件是全局执行规则，不是体系说明书。 -引用文件：`管理系统说明.md`；`体系说明.md`；`体系创建流程.md`；`全局存储体系.md`；`全局数据格式.md`；`common/ai-workplace/AI工作空间创建指南.md`；`common/pro-doc/产品规范.md`；`common/pro-doc/需求规范.md`；`common/dev-doc/编码规范.md`；`common/exp-doc/实验规范.md`；`common/exp-doc/实验审核规范.md`。 +引用文件：`管理系统说明.md`；`体系说明.md`；`体系创建流程.md`；`全局存储体系.md`；`全局数据格式.md`；`common/ai-workplace/AI工作空间创建指南.md`；`common/pro-doc/需求规范.md`；`common/pro-doc/需求规范.md`；`common/dev-doc/编码规范.md`；`common/exp-doc/实验规范.md`；`common/exp-doc/实验审核规范.md`。 记录方式：本文件为全局规则文档；新增规则默认追加到对应章节，重大口径变化必须保留变更说明，不得静默覆盖历史原因。 ## 1. 文档定位 @@ -26,8 +26,8 @@ 本文件适用于： 1. `manage_system` 下所有项目。 -2. 所有项目管理员、开发 AI、产品 AI、实验员、案例分析员、审核员和临时协作 AI。 -3. 所有产品、需求、编码、实验、案例分析、数据处理、审计和归档事项。 +2. 所有项目管理员、开发 AI、需求 AI、实验员、案例分析员、审核员和临时协作 AI。 +3. 所有需求、编码、实验、案例分析、数据处理、审计和归档事项。 规范优先级： @@ -59,7 +59,7 @@ ## 3. 体系插件原则 -`common/` 下的产品体系、开发体系、实验体系、数据体系、案例分析体系，都是体系插件。项目体系和开发体系是项目创建时默认自带的基础体系；其他体系由项目管理员按需启用。 +`common/` 下的需求体系、开发体系、实验体系、数据体系、案例分析体系，都是体系插件。项目体系和开发体系是项目创建时默认自带的基础体系；其他体系由项目管理员按需启用。 默认口径： @@ -184,7 +184,7 @@ ```text common/ project-doc/ 项目规范、项目创建、项目审计规范 - pro-doc/ 产品、需求、策略规范 + pro-doc/ 需求、策略规范 dev-doc/ 开发体系、编码、测试、代码审核规范 exp-doc/ 实验规范、实验模板、实验审核规范 data-doc/ 数据存储、数据样本、数据字典规范 @@ -212,7 +212,7 @@ ```text dev/ 开发代码根目录；具体代码放 dev/<target>-dev/ dev-doc/ 开发文档根目录；根级开发账本和规范放 dev-doc/；目标代码文档和方案附件放 dev-doc/<target>-doc/ -pro-doc/ 产品文档、需求文档 +pro-doc/ 需求文档、策略说明、业务规则说明 exp-doc/ 实验文档 exp-data/ 实验数据和结果包 ana-doc/ 案例分析文档 @@ -252,7 +252,7 @@ 默认角色： 1. 项目管理员：项目根目录管理权限。 -2. 产品 AI：`pro-doc/` 写权限，负责产品、需求、策略和业务规则文档。 +2. 需求 AI：`pro-doc/` 写权限，负责需求、策略和业务规则文档。 3. 开发 AI：按目标体系绑定 `dev/<target>-dev/`、`dev/<target>-dev/test/`、`dev-doc/<target>-doc/` 写权限；不默认拥有所有开发子目录写权限。 4. 实验员：`exp-doc/`、`exp-data/` 写权限。 5. 案例分析员：`ana-doc/`、`ana-data/` 写权限。 @@ -334,7 +334,7 @@ 事项类型可以包括： -1. 产品事项。 +1. 需求事项。 2. 需求事项。 3. 编码事项。 4. 实验事项。 diff --git "a/\347\256\241\347\220\206\347\263\273\347\273\237\350\257\264\346\230\216.md" "b/\347\256\241\347\220\206\347\263\273\347\273\237\350\257\264\346\230\216.md" index 9add1ab..b4071c9 100644 --- "a/\347\256\241\347\220\206\347\263\273\347\273\237\350\257\264\346\230\216.md" +++ "b/\347\256\241\347\220\206\347\263\273\347\273\237\350\257\264\346\230\216.md" @@ -11,7 +11,8 @@ 2）该文件的职责，负责记录什么内容 3）该文件的书写管理规范，以及对应模版 4）该文件引用的其他关键文件（相对路径） -5）该文件的记录方式，是append，还是其他，最新的内容是否在最后面 +5）该引用该文件的，其他文件也要引用它 +6）该文件的记录方式，是append，还是其他，最新的内容是否在最后面 2. 每一个文件创建以后，所在文件夹里的导读文件必须同步更新 3. 每个文件夹里都应该有一个导读文档，该导读文档记录了所有该文件夹里文件的作用，以及该目录里所有子文件夹的作用，所以每一个文件创建以后也应该更新该导读文档 ##### 文件删除 @@ -32,14 +33,14 @@ 3. 每一个角色拥有该角色绑定的文件夹和文件夹里的文件和子文件夹的写权限，非绑定的文件夹没有写权限 4. 每一个AI在一个项目里有自己的工作目录，AI拥有该工作目录下的所有权限 5. 审核员在核验的时候有证据链上的所有的脚本和代码的执行权限 -6. 比较特殊的两个角色是：开发和审核员，这两个角色是跟别的体系走的，同时审核员基本上面对任何一个角色都1对1的情况，比如产品体系，应该有 产品，产品审核员,产品开发，以及产品开发审核员。 +6. 比较特殊的两个角色是：开发和审核员，这两个角色是跟别的体系走的，同时审核员基本上面对任何一个角色都1对1的情况，比如需求体系，应该有 需求，需求审核员,需求开发，以及需求开发审核员。 ##### AI角色介绍 -1. 开发：绑定路径 /dev/对应的体系 /dev-doc/对应的体系，比如:产品开发 /dev/pro-dev /dev-doc/pro-doc, 实验开发 /dev/exp-dev /dev-doc/exp-doc -2. 产品 ：绑定路径 /pro-doc +1. 开发：绑定路径 /dev/对应的体系 /dev-doc/对应的体系，比如:需求开发 /dev/pro-dev /dev-doc/pro-doc, 实验开发 /dev/exp-dev /dev-doc/exp-doc +2. 需求 ：绑定路径 /pro-doc 3. 实验员：绑定路径/exp-doc /exp-data 4. 案例分析员：绑定路径/ana-doc /ana-data 5. 项目管理员：绑定路径项目根目录/ -6. 审核员：审核员必须是对应上面的角色之一的审核员，不绑定任何目录，只能写对应的审核体系的审核报告.md。比如说产品审计员那只能写 /pro-doc/产品审计报告.md ，比如产品开发审核员只能写 +6. 审核员：审核员必须是对应上面的角色之一的审核员，不绑定任何目录，只能写对应的审核体系的审核报告.md。比如说需求审计员那只能写 /pro-doc/需求审计报告.md ，比如需求开发审核员只能写 /dev-doc/pro-doc/开发审计报告.md @@ -87,7 +88,7 @@ ###common 说明：所有公共文件和文档都存放在common文件夹其中包括 -1.产品和策略相关的文档存放在pro-doc文件夹比如： +1.需求和策略相关的文档存放在pro-doc文件夹比如： pro-doc/需求规范.md 2.代码相关的的文档存放在dev-doc文件夹比如： dev-doc/编码规范.md @@ -133,10 +134,10 @@ /dev-doc : 存放所有开发相关的文档 /dev:存放所有的代码 /dev/体系文件夹/test: 存放所有测试代码 -开发体系比较特殊，因为单独开发没有存在的意义，所以开发是要绑定其他体系的，比如产品开发，实验开发，那对应的文件夹管理就是 -/dev/pro-dev/ 产品开发代码 /dev/pro-dev/test 产品测试代码 /dev-doc/pro-doc/ 产品开发文档 -2.产品体系 -/pro-doc: 存放所有的产品文档 +开发体系比较特殊，因为单独开发没有存在的意义，所以开发是要绑定其他体系的，比如需求开发，实验开发，那对应的文件夹管理就是 +/dev/pro-dev/ 需求开发代码 /dev/pro-dev/test 需求测试代码 /dev-doc/pro-doc/ 需求开发文档 +2.需求体系 +/pro-doc: 存放所有的需求文档 3.实验体系 /exp-doc：存放所有的实验文档 /exp-data：存放所有的实验数据 @@ -169,7 +170,7 @@ 核心：项目体系和开发体系是项目创建好就必须自带的体系 -1. 产品体系 +1. 需求体系 2. 开发体系 3. 实验体系 4. 案例分析体系 @@ -259,12 +260,14 @@ ## 技能 1. 文档文件（不包含数据，代码等文件）创建，删除，修改技能(属于全局规范.md);参考章节 文件管理（文件增，删，改） +下面所有的技能都不得违反全局规范.md的要求 2. 项目创建技能 以及 项目体系创建技能; 参考 章节体系管理员必须具备的能力 （属于manage_system\common\project-doc\项目环境创建指南.md) +下面所有的技能都不得违反全局项目规范.md的要求 和 本地项目规范.md的要求 3. AI工作空间创建 以及 AI角色分配技能; 参考 章节体系管理员必须具备的能力（属于manage_system\common\project-doc\AI工作空间创建指南.md) 4. 实验技能（包括实验设计，到实验执行）; （属于manage_system\common\exp-doc\实验规范.md 以及 项目本地 exp-doc\实验规范.md 两个共同作用的技能 ) 5. 实验审核技能（包括实验设计审核，以及实验全流程审核）;（属于manage_system\common\exp-doc\实验审核规范.md 以及 项目本地 exp-doc\实验审核规范.md 两个共同作用的技能 ) -6. 需求文档编写技能(包括需求方案文档，以及需求文档修改和书写）;（属于manage_system\common\pro-doc\产品规范.md 以及 项目本地 pro-doc\产品规范.md 两个共同作用的技能 ) -7. 需求审核技能(包括需求方案文档以及需求文档修的审核）;（属于manage_system\common\pro-doc\产品审核规范.md 以及 项目本地 pro-doc\产品审核规范.md 两个共同作用的技能 ) +6. 需求文档编写技能(包括需求方案文档，以及需求文档修改和书写）;（属于manage_system\common\pro-doc\需求规范.md 以及 项目本地 pro-doc\需求规范.md 两个共同作用的技能 ) +7. 需求审核技能(包括需求方案文档以及需求文档修的审核）;（属于manage_system\common\pro-doc\需求审核规范.md 以及 项目本地 pro-doc\需求审核规范.md 两个共同作用的技能 ) 8. 写代码技能（包括编码方案设计，到代码书写）;（属于manage_system\common\dev-doc\编码规范.md 以及 项目本地 dev-doc\编码规范.md 两个共同作用的技能 ) 9. 代码审核技能（包括编码方案设计到代码书写的审核）;（属于manage_system\common\dev-doc\开发审计规范.md 以及 项目本地 dev-doc\开发审计规范.md 两个共同作用的技能 ) 10. 案例分析技能（包括案例分析设计，案例分析全流程）;（属于manage_system\common\dev-doc\案例分析规范.md 以及 项目本地 dev-doc\案例分析规范.md 两个共同作用的技能 ) -- Gitblit v1.9.3