# 文档目录说明（`doc/`） 本仓库**主文档根目录为 `doc/`**。请勿在仓库根目录再新建并列的 `docs/` 存放本仓库文档（历史 `docs/` 已并入此处）。 --- ## 与子目录 `ai-dop-platform/docs/` 的区别 | 路径 | 归属 | 用途 | |------|------|------| | **`doc/`**（本文件所在） | Ai-DOP **主库**（含 `Web/`、`server/`） | 主库业务方案、审批流说明、会议记录、数据库导出脚本等 | | **`ai-dop-platform/docs/`** | **子目录** `ai-dop-platform` | 平台侧架构、上手、SQL、SmartOps 数据模型等，**不随本次合并迁移** | 在 Cursor 中引用平台文档时，仍使用 `@ai-dop-platform/docs/...`。 --- ## 目录约定 | 子目录 / 位置 | 放置内容 | |----------------|----------| | **`doc/plan/`** | 各模块/专题的**实施方案、设计说明**（如 `plan/S1/`） | | **`doc/meeting/`** | 会议纪要、评审记录、过程性附件 | | **`doc/db/`** | 与主库相关的**表结构导出、生成脚本**（如 Excel、Python） | | **`doc/` 根下** | 跨模块的**功能说明、集成指南**等独立 Markdown（命名建议见下） | | **`doc/img/`**、`doc/shop/` 等 | 文档用**图片、截图**等资源（保持现有结构即可） | --- ## 命名与格式 1. **语言**：面向团队的说明以**中文**为主；需对外或开源时再提供英文版可复制路径。 2. **文件名**：使用可读中文或 `模块-主题.md`，避免无意义缩写；审批流相关已约定： - `审批流功能说明.md` — 用户/产品视角功能清单 - `审批流集成开发指南.md` — 开发接入步骤与 API 3. **新增文档**：优先放入上表对应子目录；若无合适子目录，放在 `doc/` 根并在本 README「文档索引」中补一行（或后续集中整理到子目录）。 4. **大附件**：二进制、Excel、SQL 体积较大时，可放在 `doc/db/` 或专题子目录，**不要**把生成物硬编码为机器绝对路径；脚本输出宜相对脚本目录（参见 `doc/db/gen_table_excel.py`）。 --- ## 文档索引（维护中） | 文档 | 说明 | |------|------| | [审批流功能说明.md](./审批流功能说明.md) | 审批流菜单、审批中心、设计器、通知与权限 | | [审批流集成开发指南.md](./审批流集成开发指南.md) | `IFlowBizHandler`、`ApprovalPanel`、配置与 API | | [Windows后端WinSW守护重启方案.md](./Windows后端WinSW守护重启方案.md) | Windows 服务器上使用 WinSW 守护后端服务、自动重启与日志落盘 | | [plan/S1/S1-订单管理-审批流程实施方案.md](./plan/S1/S1-订单管理-审批流程实施方案.md) | S1 订单审批实施方案 | | [plan/S1-S3业务逻辑测试与数据准备方案.md](./plan/S1-S3业务逻辑测试与数据准备方案.md) | S1-S3 完整业务逻辑测试 case 与测试数据准备方案 | | [plan/S1-S4全局UAT场景测试数据生成方案.md](./plan/S1-S4全局UAT场景测试数据生成方案.md) | S1-S4 全局 UAT 场景测试数据主线，要求订单、工单、物料、采购、交货跨模块串联 | | [plan/S1/S1产销协同UAT测试数据抽取与导入方案.md](./plan/S1/S1产销协同UAT测试数据抽取与导入方案.md) | S1 UAT 场景化测试数据抽取范围、AIDOP 租户归属、导入顺序与验收 SQL | | [plan/S1/S1产销协同UAT候选数据清单与导入映射.md](./plan/S1/S1产销协同UAT候选数据清单与导入映射.md) | S1 UAT 首批候选单号、场景化造数原则、目标表映射、批次标记与 SQL 草案 | | [plan/S1/S1产销协同UAT数据生成执行任务书.md](./plan/S1/S1产销协同UAT数据生成执行任务书.md) | 给其它大模型或协作者执行 S1 UAT 数据生成的阶段任务、约束、确认点与验收标准 | | [plan/S2/S2制造协同UAT测试数据生成方案.md](./plan/S2/S2制造协同UAT测试数据生成方案.md) | S2 制造协同 UAT 测试数据包、工单排程、产线日历、日计划、看板与验收方向 | | [plan/S2/S2制造协同UAT数据生成执行任务书.md](./plan/S2/S2制造协同UAT数据生成执行任务书.md) | 给其它大模型或协作者执行 S2 UAT 数据生成的阶段任务、约束、确认点与验收标准 | | [plan/S3/S3供应协同UAT测试数据生成方案.md](./plan/S3/S3供应协同UAT测试数据生成方案.md) | S3 供应协同 UAT 测试数据包、物料需求、交货计划、采购、委外外协与看板验收方向 | | [plan/S3/S3供应协同UAT数据生成执行任务书.md](./plan/S3/S3供应协同UAT数据生成执行任务书.md) | 给其它大模型或协作者执行 S3 UAT 数据生成的阶段任务、约束、确认点与验收标准 | | [plan/S4/S4采购执行UAT测试数据生成方案.md](./plan/S4/S4采购执行UAT测试数据生成方案.md) | S4 采购执行 UAT 测试数据包，当前以测试报告驱动，覆盖交货、发货、退货、IQC 与欠料看板 | | [plan/S4/S4采购执行UAT数据生成执行任务书.md](./plan/S4/S4采购执行UAT数据生成执行任务书.md) | 给其它大模型或协作者执行 S4 UAT 数据生成的阶段任务、约束、确认点与验收标准 | | [plan/S0-CodeFirst启动异常与BOM历史数据治理方案.md](./plan/S0-CodeFirst启动异常与BOM历史数据治理方案.md) | S0 legacy BOM 表 CodeFirst 启动异常、根因与彻底治理步骤 | | [plan/S8/S8数据库处理优化方案.md](./plan/S8/S8数据库处理优化方案.md) | S8 调度、检测日志、通知扫描与数据库写入压力优化方案 | | [plan/新系统数据库简明介绍与S1数据流.md](./plan/新系统数据库简明介绍与S1数据流.md) | 新系统数据库简明说明，并以 S1 为例说明数据中台流转 | | [plan/数据中台方案复盘与未实现清单.md](./plan/数据中台方案复盘与未实现清单.md) | 数据中台总体方案、S1-S3 当前进度、未实现事项和后续优先级复盘 | | [plan/动态运营详情看板与指标改善闭环方案.md](./plan/动态运营详情看板与指标改善闭环方案.md) | 动态运营详情看板、智慧诊断与改善闭环总体方案 | | [plan/看板查询条件现状分析.md](./plan/看板查询条件现状分析.md) | 看板查询条件为何不影响 KPI、前后端数据流与改造方向 | | [plan/数据中台模块扩展指南-S1至S3经验版.md](./plan/数据中台模块扩展指南-S1至S3经验版.md) | 基于 S1-S3 经验的 S4-S8 数据中台、KPI 报表与看板扩展指南，含 Cursor 小步闭环任务模板 | | [plan/数据库迁移/S1/S1-任务交接记忆.md](./plan/数据库迁移/S1/S1-任务交接记忆.md) | **S1 数据中台迁移**跨会话交接（当前进度、阻塞、验收 SQL） | | [plan/数据库迁移/S1/S1数据中台迁移实施计划.md](./plan/数据库迁移/S1/S1数据中台迁移实施计划.md) | S1 数据中台迁移主方案与分块步骤 | | [plan/数据库迁移/S2/S2数据中台与KPI扩展验收.md](./plan/数据库迁移/S2/S2数据中台与KPI扩展验收.md) | S2 生产排程数据中台链路、KPI 写入与验收 SQL | | [plan/数据库迁移/S3/S3数据中台与看板动态化验收.md](./plan/数据库迁移/S3/S3数据中台与看板动态化验收.md) | S3 供应协同数据中台链路、看板动态化与验收 SQL | | [plan/数据中台模块扩展开发指南-S3范式.md](./plan/数据中台模块扩展开发指南-S3范式.md) | 数据中台扩展（仿 S3）：四库逻辑、作业与 Cursor 协作 | | [db/mdp/README.md](./db/mdp/README.md) | S4/S8 相关 mdp、dwd 等建表脚本说明与执行顺序 | | [指标模型动态配置方案.md](./指标模型动态配置方案.md) | 指标模型动态配置总体方案 | | [meeting/20260408/vue-tsc-既存类型错误说明.md](./meeting/20260408/vue-tsc-既存类型错误说明.md) | 前端类型问题说明 | **指标模型（SmartOps）主设计**仍在：`ai-dop-platform/docs/db/smart_ops_data_model/README.txt`。 --- ## 变更记录 - **2026-04-16**：根目录 `docs/` 已合并至 `doc/`（含 `doc/db/` 与根下方案文档），并增加本规范文件。