From bdcfa2500ecfd5e821fa4ca1930d7335613d655a Mon Sep 17 00:00:00 2001 From: Hermes CI Fix Date: Mon, 7 Sep 2026 16:08:55 +0800 Subject: [PATCH] =?UTF-8?q?docs(manuals):=20=E6=8F=90=E4=BA=A4=E6=89=8B?= =?UTF-8?q?=E5=86=8C=E6=A8=A1=E6=9D=BF=20=5Ftemplate.md=EF=BC=886=E6=AE=B5?= =?UTF-8?q?=E7=BB=93=E6=9E=84=EF=BC=8C=E9=9A=8F=E9=A6=96=E6=89=B9=E6=89=8B?= =?UTF-8?q?=E5=86=8C=E5=85=A5=E5=BA=93=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/manuals/_template.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/manuals/_template.md diff --git a/docs/manuals/_template.md b/docs/manuals/_template.md new file mode 100644 index 00000000..dc626dd1 --- /dev/null +++ b/docs/manuals/_template.md @@ -0,0 +1,39 @@ +# 模板:CMA 模块操作手册(v1.0,2026-09-07 任总确认固化) + +> 用途:每开发/验证完一个 CMA 模块,产出/更新本手册。防重复修改(先查手册再动手)、防重复验证(照清单执行)。 +> 存放:CMA 知识库(操作人员可见)+ `/root/cma-management/docs/manuals/<模块slug>.md`(开发/Bot 可见)双份。 +> 更新触发:每次该模块 bug 修复/功能变更 → 同步更新本手册(防手册过期不如没有)。 + +## ① 模块定位 +- **模块名**: +- **解决什么问题**: +- **所属流程环节**:(如 预算→版本管理 / 数据→账套切换 / 工作台→我的KPI) +- **主要角色**:(谁操作:ceo/finance/business/it/普通员工) + +## ② 操作步骤 + + +## ③ 验证路径 + +- **自动脚本**: +- **期望输出**: +- **已测基线**(最近一次验证日期+结果): + +## ④ 已知边界 / 坑 + +- **历史 bug**:(日期+问题+修复) +- **边界条件**:(如 active 状态可提交、approved 只读、跨企业 404 等) +- **⚠️ 易踩点**: + +## ⑤ 修改记录 +| 日期 | 修改人 | 改动 | commit | 影响 | +|------|--------|------|--------|------| +| 2026-09-07 | - | 手册创建 | - | - | + +## ⑥ 关联 +- **依赖表**:(budget_plans/kpi_definitions/kpi_alerts...) +- **依赖接口**:(GET /api/cma/...) +- **关联模块**: + +--- +