40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
# 模板：CMA 模块操作手册（v1.0，2026-09-07 任总确认固化）
|
||
|
||
> 用途：每开发/验证完一个 CMA 模块，产出/更新本手册。防重复修改（先查手册再动手）、防重复验证（照清单执行）。
|
||
> 存放：CMA 知识库（操作人员可见）+ `/root/cma-management/docs/manuals/<模块slug>.md`（开发/Bot 可见）双份。
|
||
> 更新触发：每次该模块 bug 修复/功能变更 → 同步更新本手册（防手册过期不如没有）。
|
||
|
||
## ① 模块定位
|
||
- **模块名**：
|
||
- **解决什么问题**：
|
||
- **所属流程环节**：（如 预算→版本管理 / 数据→账套切换 / 工作台→我的KPI）
|
||
- **主要角色**：（谁操作：ceo/finance/business/it/普通员工）
|
||
|
||
## ② 操作步骤
|
||
<!-- 谁在什么角色下怎么操作，含页面路径/按钮路径/关键字段 -->
|
||
|
||
## ③ 验证路径
|
||
<!-- 跑哪个 verify 脚本 + 期望输出 + 已测基线（数字/日期）；没有脚本就写手工验证步骤 -->
|
||
- **自动脚本**：
|
||
- **期望输出**：
|
||
- **已测基线**（最近一次验证日期+结果）：
|
||
|
||
## ④ 已知边界 / 坑
|
||
<!-- 这个模块改过什么 bug、哪里容易踩、什么状态下不能做什么 -->
|
||
- **历史 bug**：（日期+问题+修复）
|
||
- **边界条件**：（如 active 状态可提交、approved 只读、跨企业 404 等）
|
||
- **⚠️ 易踩点**：
|
||
|
||
## ⑤ 修改记录
|
||
| 日期 | 修改人 | 改动 | commit | 影响 |
|
||
|------|--------|------|--------|------|
|
||
| 2026-09-07 | - | 手册创建 | - | - |
|
||
|
||
## ⑥ 关联
|
||
- **依赖表**：（budget_plans/kpi_definitions/kpi_alerts...）
|
||
- **依赖接口**：（GET /api/cma/...）
|
||
- **关联模块**：
|
||
|
||
---
|
||
<!-- 注意：更新本手册时必须同时更新 ⑤修改记录；队列状态见 /root/WB_WS/_registry/cma-module-queue.json -->
|