From b0e174e4fdcec744f20d96849521cc9e31e2c190 Mon Sep 17 00:00:00 2001 From: cai <cai@nbcai.cc> Date: Thu, 04 Jun 2026 14:32:10 +0800 Subject: [PATCH] 补充文档 --- common/data-doc/mbx.system.yaml | 24 +++ common/dev-doc/mbx.system.yaml | 65 +++++++++ common/project-doc/mbx.system.yaml | 79 +++++++++++ common/exp-doc/mbx.system.yaml | 69 +++++++++ common/ana-doc/mbx.system.yaml | 69 +++++++++ common/pro-doc/mbx.system.yaml | 59 ++++++++ 管理系统说明.md | 42 +++--- 7 files changed, 386 insertions(+), 21 deletions(-) diff --git a/common/ana-doc/mbx.system.yaml b/common/ana-doc/mbx.system.yaml new file mode 100644 index 0000000..150b821 --- /dev/null +++ b/common/ana-doc/mbx.system.yaml @@ -0,0 +1,69 @@ +dirs: + - ana-doc + - ana-data + - ana-data/cases + - ana-data/result + - ana-data/img + - ana-data/tmp +docs: + catalog: ana-doc/目录导读.md + norm: ana-doc/案例分析规范.md + audit_norm: ana-doc/案例审核规范.md + storage: ana-doc/案例存储体系.md + outline: ana-doc/案例总纲.md + design: ana-doc/案例分析设计.md + execution_log: ana-doc/案例执行日志.md + audit_report: ana-doc/案例审计报告.md + issue_record: ana-doc/案例问题记录.md +default_roles: + - analyst + - reviewer +roles: + - role_key: analyst + name: 案例分析员 + workdir: ana-data + private_dir: ai-case-analysis-analyst + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - ana-doc/目录导读.md + - ana-doc/案例分析规范.md + - ana-doc/案例总纲.md + - ana-doc/案例分析设计.md + - ana-doc/案例执行日志.md + - ana-doc/案例存储体系.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - ana-doc + - ana-data + - role_key: reviewer + name: 案例审核员 + workdir: ana-data + private_dir: ai-case-analysis-reviewer + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - ana-doc/目录导读.md + - ana-doc/案例分析规范.md + - ana-doc/案例审核规范.md + - ana-doc/案例总纲.md + - ana-doc/案例分析设计.md + - ana-doc/案例执行日志.md + - ana-doc/案例审计报告.md + - ana-doc/案例问题记录.md + - ana-doc/案例存储体系.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - ana-doc/案例审计报告.md + - ana-doc/案例问题记录.md + - ai-case-analysis-reviewer diff --git a/common/data-doc/mbx.system.yaml b/common/data-doc/mbx.system.yaml new file mode 100644 index 0000000..574fd69 --- /dev/null +++ b/common/data-doc/mbx.system.yaml @@ -0,0 +1,24 @@ +dirs: + - data-doc + - data +docs: + catalog: data-doc/目录导读.md +default_roles: [] +roles: + - role_key: steward + name: 数据管理员 + workdir: data + private_dir: ai-data-steward + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - data-doc/目录导读.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - data-doc + - data diff --git a/common/dev-doc/mbx.system.yaml b/common/dev-doc/mbx.system.yaml new file mode 100644 index 0000000..60627c7 --- /dev/null +++ b/common/dev-doc/mbx.system.yaml @@ -0,0 +1,65 @@ +dirs: + - dev + - dev/test + - dev/tmp + - dev-doc +docs: + catalog: dev-doc/目录导读.md + norm: dev-doc/编码规范.md + audit_norm: dev-doc/开发审计规范.md + outline: dev-doc/开发事项总纲.md + plan: dev-doc/开发事项计划.md + execution_log: dev-doc/开发执行日志.md + audit_report: dev-doc/开发审计报告.md + issue_record: dev-doc/开发问题记录.md +default_roles: + - developer + - reviewer +roles: + - role_key: developer + name: 开发员 + workdir: dev + private_dir: ai-dev-developer + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - dev-doc/目录导读.md + - dev-doc/编码规范.md + - dev-doc/开发审计规范.md + - dev-doc/开发事项总纲.md + - dev-doc/开发事项计划.md + - dev-doc/开发执行日志.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - dev + - dev-doc + - role_key: reviewer + name: 编码审核员 + workdir: dev + private_dir: ai-dev-reviewer + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.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 + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - dev-doc/开发审计报告.md + - dev-doc/开发问题记录.md + - ai-dev-reviewer diff --git a/common/exp-doc/mbx.system.yaml b/common/exp-doc/mbx.system.yaml new file mode 100644 index 0000000..2063327 --- /dev/null +++ b/common/exp-doc/mbx.system.yaml @@ -0,0 +1,69 @@ +dirs: + - exp-doc + - exp-data + - exp-data/raw + - exp-data/result + - exp-data/img + - exp-data/tmp +docs: + catalog: exp-doc/目录导读.md + norm: exp-doc/实验规范.md + audit_norm: exp-doc/实验审核规范.md + storage: exp-doc/实验存储体系.md + outline: exp-doc/实验总纲.md + design: exp-doc/实验设计.md + execution_log: exp-doc/实验执行日志.md + audit_report: exp-doc/实验审计报告.md + issue_record: exp-doc/实验问题记录.md +default_roles: + - experimenter + - reviewer +roles: + - role_key: experimenter + name: 实验员 + workdir: exp-data + private_dir: ai-experiment-experimenter + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - exp-doc/目录导读.md + - exp-doc/实验规范.md + - exp-doc/实验总纲.md + - exp-doc/实验设计.md + - exp-doc/实验执行日志.md + - exp-doc/实验存储体系.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - exp-doc + - exp-data + - role_key: reviewer + name: 实验审核员 + workdir: exp-data + private_dir: ai-experiment-reviewer + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - exp-doc/目录导读.md + - exp-doc/实验规范.md + - exp-doc/实验审核规范.md + - exp-doc/实验总纲.md + - exp-doc/实验设计.md + - exp-doc/实验执行日志.md + - exp-doc/实验审计报告.md + - exp-doc/实验问题记录.md + - exp-doc/实验存储体系.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - exp-doc/实验审计报告.md + - exp-doc/实验问题记录.md + - ai-experiment-reviewer diff --git a/common/pro-doc/mbx.system.yaml b/common/pro-doc/mbx.system.yaml new file mode 100644 index 0000000..c1b8e61 --- /dev/null +++ b/common/pro-doc/mbx.system.yaml @@ -0,0 +1,59 @@ +dirs: + - pro-doc +docs: + catalog: pro-doc/目录导读.md + norm: pro-doc/需求规范.md + audit_norm: pro-doc/需求审核规范.md + outline: pro-doc/需求总纲.md + design: pro-doc/需求设计.md + execution_log: pro-doc/需求执行日志.md + audit_report: pro-doc/需求审计报告.md + issue_record: pro-doc/需求问题记录.md +default_roles: + - product +roles: + - role_key: product + name: 产品 + workdir: pro-doc + private_dir: ai-requirement-product + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - pro-doc/目录导读.md + - pro-doc/需求规范.md + - pro-doc/需求总纲.md + - pro-doc/需求设计.md + - pro-doc/需求执行日志.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - pro-doc + - role_key: reviewer + name: 需求审核员 + workdir: pro-doc + private_dir: ai-requirement-reviewer + docs_to_read: + - 项目规范.md + - 项目配置清单.md + - 项目协作流程.md + - pro-doc/目录导读.md + - pro-doc/需求规范.md + - pro-doc/需求审核规范.md + - pro-doc/需求总纲.md + - pro-doc/需求设计.md + - pro-doc/需求执行日志.md + - pro-doc/需求审计报告.md + - pro-doc/需求问题记录.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - pro-doc/需求审计报告.md + - pro-doc/需求问题记录.md + - ai-requirement-reviewer diff --git a/common/project-doc/mbx.system.yaml b/common/project-doc/mbx.system.yaml new file mode 100644 index 0000000..2d6f523 --- /dev/null +++ b/common/project-doc/mbx.system.yaml @@ -0,0 +1,79 @@ +dirs: + - . + - tmp +docs: + norm: 项目规范.md + overview: 项目总览.md + config: 项目配置清单.md + matter_outline: 项目事项总纲.md + matter_plan: 项目事项计划.md + execution_log: 项目执行日志.md + audit_report: 项目事项审计报告.md + issue_record: 项目问题记录.md + change_record: 项目变更记录.md +default_roles: + - admin + - reviewer +roles: + - role_key: admin + name: 项目管理员 + workdir: . + private_dir: ai-project-admin + docs_to_read: + - 项目规范.md + - 项目总览.md + - 项目配置清单.md + - 项目协作流程.md + - 项目事项总纲.md + - 项目事项计划.md + - 项目执行日志.md + - 项目变更记录.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - . + - role_key: reviewer + name: 项目审核员 + workdir: . + private_dir: ai-project-reviewer + docs_to_read: + - 项目规范.md + - 项目总览.md + - 项目配置清单.md + - 项目协作流程.md + - 项目事项总纲.md + - 项目事项计划.md + - 项目执行日志.md + - 项目变更记录.md + - 项目事项审计报告.md + - 项目问题记录.md + permission: + mode: full_control + sandbox: danger-full-access + approval: never + bypass_sandbox_and_approvals: false + write_paths: + - 项目事项审计报告.md + - 项目问题记录.md + - ai-project-reviewer + - role_key: observer + name: 项目观察员 + workdir: . + private_dir: ai-project-observer + docs_to_read: + - 项目规范.md + - 项目总览.md + - 项目配置清单.md + - 项目协作流程.md + - 项目事项总纲.md + - 项目执行日志.md + permission: + mode: read_only + sandbox: read-only + approval: never + bypass_sandbox_and_approvals: false + read_paths: + - . 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 8df00da..069650e 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" @@ -1,8 +1,8 @@ -#管理体系说明 +# 管理体系说明 ## 管理体系核心 -###全局管理 +### 全局管理 #### 文件管理（文件增，删，改） ##### 文件创建 @@ -86,7 +86,7 @@ ## 文件夹管理 -###common +### common 说明：所有公共文件和文档都存放在common文件夹其中包括 1.需求和策略相关的文档存放在pro-doc文件夹比如： pro-doc/需求规范.md @@ -101,7 +101,7 @@ 6.全局规范.md 该文件负责存储所有全局规范和全局约定，所有 AI 都应该遵守该文档 -###项目文件夹 +### 项目文件夹 设计核心：体系文件夹，包括项目文件夹都属于整个项目的公共文件夹，它们属于项目组里大家共有的东西， 但是AI工作空间，不属于项目公有的东西，AI工作空间属于自己私产，包括最后项目打包上线也不会涵盖AI工作空间的内容。 @@ -114,7 +114,7 @@ 5. 其他 -####项目配置清单 +#### 项目配置清单 在项目文件夹下有一个项目配置清单.md文件 里面的格式大概如下： 1.AI名：Andrew @@ -125,10 +125,10 @@ 工作空间: ai-foo/ -####体系文件夹 +#### 体系文件夹 1.每一个项目每添加一个体系，那么该项目文件夹里就应该包含该体系所需要的文件夹 -####已有体系的文件夹说明 +#### 已有体系的文件夹说明 1.开发体系 /dev-doc : 存放所有开发相关的文档 @@ -160,7 +160,7 @@ -###data +### data data里存放全局统一的数据源 @@ -176,9 +176,9 @@ 4. 案例分析体系 5. 项目体系 -###体系组件 +### 体系组件 -####核心目标和原则 +#### 核心目标和原则 -- 可审计，任何人都可以审计在该体系中，该每一个AI的每一个进行中或者历史事项全景包括： 1. 事项的状态 2. 事项的前因，中间关键节点，结果 @@ -261,19 +261,19 @@ ## 技能 1. 文档文件（不包含数据，代码等文件）创建，删除，修改技能(属于全局规范.md);参考章节 文件管理（文件增，删，改） 下面所有的技能都不得违反全局规范.md的要求 -2. 项目创建技能 以及 项目体系创建技能; 参考 章节体系管理员必须具备的能力 （属于manage_system\common\project-doc\项目环境创建指南.md) +2. 项目创建技能 以及 项目体系创建技能; 参考 章节体系管理员必须具备的能力 （属于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 两个共同作用的技能 ) -8. 写代码技能（包括编码方案设计，到代码书写）;（属于manage_system\common\dev-doc\编码规范.md 以及 项目本地 dev-doc\编码规范.md 两个共同作用的技能 ) -9. 代码审核技能（包括编码方案设计到代码书写的审核）;（属于manage_system\common\dev-doc\开发审计规范.md 以及 项目本地 dev-doc\开发审计规范.md 两个共同作用的技能 ) -10. 案例分析技能（包括案例分析设计，案例分析全流程）;（属于manage_system\common\ana-doc\案例分析规范.md 以及 项目本地 ana-doc\案例分析规范.md 两个共同作用的技能 ) -11. 案例分析审核技能（包括案例分析设计，案例分析全流程审计）;（属于manage_system\common\ana-doc\案例审核规范.md 以及 项目本地 ana-doc\案例审核规范.md 两个共同作用的技能 ) +3. AI工作空间创建 以及 AI角色分配技能; 参考 章节体系管理员必须具备的能力（属于common\project-doc\AI工作空间创建指南.md) +4. 实验技能（包括实验设计，到实验执行）; （属于common\exp-doc\实验规范.md 以及 项目本地 exp-doc\实验规范.md 两个共同作用的技能 ) +5. 实验审核技能（包括实验设计审核，以及实验全流程审核）;（属于common\exp-doc\实验审核规范.md 以及 项目本地 exp-doc\实验审核规范.md 两个共同作用的技能 ) +6. 需求文档编写技能(包括需求方案文档，以及需求文档修改和书写）;（属于common\pro-doc\需求规范.md 以及 项目本地 pro-doc\需求规范.md 两个共同作用的技能 ) +7. 需求审核技能(包括需求方案文档以及需求文档修的审核）;（属于common\pro-doc\需求审核规范.md 以及 项目本地 pro-doc\需求审核规范.md 两个共同作用的技能 ) +8. 写代码技能（包括编码方案设计，到代码书写）;（属于common\dev-doc\编码规范.md 以及 项目本地 dev-doc\编码规范.md 两个共同作用的技能 ) +9. 代码审核技能（包括编码方案设计到代码书写的审核）;（属于common\dev-doc\开发审计规范.md 以及 项目本地 dev-doc\开发审计规范.md 两个共同作用的技能 ) +10. 案例分析技能（包括案例分析设计，案例分析全流程）;（属于common\ana-doc\案例分析规范.md 以及 项目本地 ana-doc\案例分析规范.md 两个共同作用的技能 ) +11. 案例分析审核技能（包括案例分析设计，案例分析全流程审计）;（属于common\ana-doc\案例审核规范.md 以及 项目本地 ana-doc\案例审核规范.md 两个共同作用的技能 ) -##体系特殊说明 +## 体系特殊说明 实验体系目前固定成如下： 1. 实验员和实验-开发员目前固定成一个ai 2. 实验员的审核员和 实验-开发员的审核员 也都固定成一个ai, 这个ai对实验的审核 以及 实验开发员 的审核都统一记录在 exp-doc/实验审计报告.md 里 -- Gitblit v1.9.3