docs: 项目规范文档+需求文档+CHANGELOG

This commit is contained in:
Hermes CI Fix
2026-05-28 17:33:38 +08:00
parent 3dddd36866
commit f79db8ccba
6 changed files with 263 additions and 97 deletions
+36
View File
@@ -0,0 +1,36 @@
# 管理会计OS — 需求文档模板
## 模块名称
> 一句话描述该模块解决什么问题
## 用户故事
作为【角色】,我希望【功能】,以便【价值】
## 功能列表
- [ ] 功能点1:描述
- [ ] 功能点2:描述
## 界面设计
(附原型图或页面布局描述)
## 数据流
(输入→处理→输出的流程说明)
## 验收标准
1. 条件1 → 预期结果
2. 条件2 → 预期结果
## 关联模块
- 依赖哪些模块
- 被哪些模块依赖
## 备注
(注意事项、已知限制、后续扩展方向)
+36
View File
@@ -0,0 +1,36 @@
# 个人工作台
> 为每个用户提供个人维度的KPI看板、改善行动和待办提醒
## 用户故事
作为业务经理/财务人员,我希望登录后第一眼看到我负责的KPI状态、我的改善行动进展,以及需要我处理的待办事项,以便快速开始一天的工作。
## 功能列表
- [x] 我的KPI列表(红黄绿灯+进度条+实际值/目标值)
- [x] 我的改善行动(状态、进度、逾期标记)
- [x] 待办提醒(逾期行动+红色预警KPI)
- [x] 角色预设KPI(CEO/财务/业务各有内置关键指标)
- [x] 首次登录自动弹出引导遮罩
## 数据流
1. 前端请求 `GET /dashboard/my-dashboard`
2. 后端匹配 `kpi_definitions.responsible_user` 拿到我的KPI
3. 补充角色预设KPI(从 `ROLE_PRESET_KPIS` 定义中读取)
4.`action_plans.assignee` 匹配我的改善行动
5. 计算逾期和红黄灯生成待办提醒
## 验收标准
- [x] 页面展示用户关联的KPI
- [x] 页面展示用户关联的改善行动
- [x] 待办提醒准确(逾期红色、预警黄色)
- [x] 无关联KPI时显示预设指标
## 后续扩展
- 管理员可配置每个角色的预设KPI列表
- 增加周报提交功能
- 增加日历待办视图
+35
View File
@@ -0,0 +1,35 @@
# 帮助支持模块
> 提供CMA知识库、新手引导和技术支持,帮助用户快速上手
## 用户故事
作为新用户,我希望有知识库可以查阅术语和公式,有引导可以快速上手,以便降低使用门槛。
## 功能列表
### CMA知识库
- [x] 四个分类:术语解释、计算公式、最佳实践、常见问题
- [x] 全文搜索(标题+摘要+内容)
- [x] 点击条目弹出详情(含图文、表格、代码示例)
- [x] 纯静态内容,无后端依赖
### 新手引导
- [x] 5步引导遮罩(欢迎→驾驶舱→KPI→战略地图→日常管理)
- [x] 首次登录自动弹出
- [x] 快速开始卡片
- [x] 使用流程概览
- [x] 视频教程占位(6个视频卡片)
### 技术支持(待实现)
- [ ] 提交工单(标题、描述、附件)
- [ ] 工单列表(状态跟踪)
- [ ] 企微通知管理员
## 验收标准
- [x] 知识库内容完整覆盖管理会计核心概念
- [x] 搜索功能正常
- [x] 新手引导首次登录弹出
- [x] 引导步进前进/后退/跳过正常
- [x] 所有角色可见(ceo/finance/business/it
+33
View File
@@ -0,0 +1,33 @@
# 战略回顾会
> 在战略地图画布基础上,为CEO/财务总监提供周会月会用的复盘视图
## 用户故事
作为CEO/财务总监,我希望进入战略回顾会页面就能看到所有战略目标的红黄绿灯状态、KPI达成情况、改善行动进展,以便在周会月会上快速掌握全局异常并决策。
## 功能列表
- [x] 整体健康度卡片(绿色/黄色/红色目标数量+健康度百分比)
- [x] 四维度矩阵展示(每个维度下的目标状态、关联KPI实际值/目标值)
- [x] 需重点关注列表(红色/黄色目标按严重度排序)
- [x] 改善行动进度表(状态、进度条、逾期标记)
- [x] KPI详情弹出(实际值、目标值、达成率)
- [x] 期间切换(本月/本季/本年)
## 数据流
1. 前端请求 `GET /maps/{id}/review`
2. 后端从 `strategic_maps.dimensions` 读取目标和关联KPI编码
3.`kpi_definitions` + `kpi_values` 获取KPI定义和最新实际值
4. 计算每个目标的红黄绿灯状态
5.`action_plans` 查询关联的改善行动
6. 返回聚合数据
## 验收标准
- [x] 后端API返回完整的目标状态+KPI值+改善行动
- [x] 前端页面正常渲染四个维度和目标卡片
- [x] 红黄绿灯颜色正确
- [x] 改善行动显示进度和逾期状态
- [x] 支持从左侧栏直接进入和从画布跳转