README.md 3.0 KB

文档目录说明(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 IFlowBizHandlerApprovalPanel、配置与 API
plan/S1/S1-订单管理-审批流程实施方案.md S1 订单审批实施方案
指标模型动态配置方案.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/ 与根下方案文档),并增加本规范文件。