docs: 用户手册
This commit is contained in:
185
.trae/documents/网络设备管理平台用户手册编写计划.md
Normal file
185
.trae/documents/网络设备管理平台用户手册编写计划.md
Normal file
@@ -0,0 +1,185 @@
|
||||
# 《网络设备管理平台用户手册》编写计划
|
||||
|
||||
本计划已根据权限系统的实际逻辑(VIEW/OPERATION)进行了调整,将在各章节中明确体现权限对界面和功能的影响。
|
||||
|
||||
## 阶段一:准备与入门
|
||||
|
||||
1. **平台简介**:平台用途与设备支持范围。
|
||||
2. **登录与注销**:账号登录流程、退出操作。
|
||||
3. **界面概览**:
|
||||
|
||||
* **顶部区域 (Header)**:展示平台标题、当前用户信息及设置入口。
|
||||
|
||||
* **侧边菜单 (Sider)**:功能模块导航。
|
||||
|
||||
* **底部状态栏 (Footer)**:未读告警通知提示。
|
||||
|
||||
* **设置面板**:
|
||||
|
||||
* **通用设置**:主题切换(深色模式)、布局调整(菜单折叠、车站列数)。
|
||||
|
||||
* **业务设置**:告警策略配置(详见阶段四)。
|
||||
4. **权限与界面差异说明(新增)**:
|
||||
|
||||
* 解释“查看权限”如何决定车站列表的显示(无权限则不显示)。
|
||||
|
||||
* 解释“操作权限”如何决定功能按钮的显隐(无权限则隐藏配置入口)。
|
||||
|
||||
## 阶段二:首页 - 车站状态监控
|
||||
|
||||
**涉及模块**:`Station Status` (首页)
|
||||
|
||||
1. **车站卡片解读**
|
||||
|
||||
* **基础信息**:车站名称、在线/离线状态。
|
||||
|
||||
* **统计数据**:设备总数/在线数/离线数、今日告警总数。
|
||||
|
||||
* **交互操作**:
|
||||
|
||||
* **右上角更多菜单**:
|
||||
|
||||
* **视频平台**:跳转至视频管理平台。
|
||||
|
||||
* **设备配置**:打开参数配置窗口 **(注:仅当拥有该车站“操作权限”且车站在线时显示)**。
|
||||
|
||||
* **设备详情入口**:点击“设备总数”区域,弹出设备树模态框(可进一步跳转诊断页)。
|
||||
|
||||
* **告警详情入口**:点击“告警总数”区域,弹出告警列表模态框。
|
||||
2. **操作栏 (Batch Actions)**
|
||||
|
||||
* **功能按钮与权限差异**:
|
||||
|
||||
* **导出设备状态 / 导出录像诊断**:**(需查看权限)** 仅可选择拥有“查看权限”的车站进行导出。
|
||||
|
||||
* **同步摄像机 / 同步录像机通道**:**(需操作权限)** 仅可选择拥有“操作权限”的车站进行同步。
|
||||
|
||||
\*- **操作流程**:
|
||||
|
||||
1. 点击操作栏中的任一功能按钮(如“同步摄像机”)。
|
||||
2. 此时车站卡片上会出现复选框,且仅有权限的车站可选。
|
||||
3. 勾选需要操作的车站(支持“全选”)。
|
||||
4. 点击操作栏右侧出现的“确定”按钮:
|
||||
|
||||
* **导出类操作**:系统将弹出预览窗口,您可在窗口中确认数据并下载 Excel 文件。
|
||||
|
||||
* **同步类操作**:系统将直接在后台启动同步任务,任务完成后右上角会弹出结果通知(成功/失败数量)。
|
||||
3. **单站详情与配置**
|
||||
|
||||
* **设备列表详情**:展示设备树,点击可跳转诊断页。
|
||||
|
||||
* **告警列表详情**。
|
||||
|
||||
* **参数配置**:配置阈值与计划任务 **(需操作权限)**。
|
||||
|
||||
## 阶段三:设备诊断模块
|
||||
|
||||
**涉及模块**:`Device Diagnosis`
|
||||
|
||||
1. **设备树(侧边栏)**
|
||||
|
||||
* **数据范围**:说明仅展示拥有“查看权限”的车站及其下属设备。
|
||||
|
||||
* **搜索与筛选**:按名称/IP搜索,按状态筛选。
|
||||
|
||||
* **树形交互**:
|
||||
|
||||
* **展开与选择**:按“车站 -> 设备类型 -> 具体设备”层级展开与选择。
|
||||
|
||||
* **右键菜单管理**:**(需操作权限)**
|
||||
|
||||
* **车站节点右键**:支持 **导入设备**、**导出设备**。
|
||||
|
||||
* **设备节点右键**:支持 **删除设备**。
|
||||
2. **诊断详情页结构**
|
||||
|
||||
* **头部信息栏**:状态、IP、关联跳转、Web管理入口。
|
||||
|
||||
* **功能标签页**:
|
||||
|
||||
* **当前诊断**:实时数据展示。
|
||||
|
||||
* **历史诊断**:历史趋势查看。
|
||||
|
||||
* **修改设备**:编辑设备信息 **(注:仅对拥有“操作权限”的用户可见)**。
|
||||
3. **特定设备诊断指标**
|
||||
- **分类描述策略**:
|
||||
- **性能类设备**(如交换机、服务器、NVR):侧重硬件监控,展示CPU/内存使用率仪表盘、端口状态、磁盘健康度等。
|
||||
- **(补充) 下游设备关联配置**:
|
||||
- **交换机**:右键点击端口 -> 关联设备(如摄像机)。
|
||||
- **安防箱**:右键点击电路 -> 关联设备。
|
||||
- **操作权限要求**:**(需操作权限)**。
|
||||
- **信息类设备**(如摄像机、报警主机):侧重参数展示,展示制造商、固件版本、协议配置等静态属性。
|
||||
|
||||
## 阶段四:告警管理模块
|
||||
|
||||
**涉及模块**:`Alarm`
|
||||
|
||||
1. **子模块:告警记录 (Alarm Log)**
|
||||
|
||||
* **筛选查询**:
|
||||
|
||||
* 组合筛选:车站(受查看权限限制)、设备类型、设备名称、告警类型、级别、状态、时间。
|
||||
|
||||
* **列表操作**:
|
||||
|
||||
* **告警确认**:点击“确认”按钮处理告警 **(注:需拥有该车站的操作权限,否则按钮禁用/隐藏)**。
|
||||
|
||||
* **忽略设备**:将设备加入忽略列表 **(需操作权限)**。
|
||||
|
||||
* **数据导出**:导出Excel报表。
|
||||
|
||||
2. **子模块:告警忽略 (Alarm Ignore)**
|
||||
|
||||
* **列表查看**:查看被忽略的设备记录。
|
||||
|
||||
* **取消忽略**:点击恢复监控 **(注:需拥有操作权限)**。
|
||||
|
||||
3. **告警策略配置 (系统设置)**
|
||||
|
||||
* **配置入口**:通过顶部导航栏“设置”按钮进入。
|
||||
|
||||
* **配置项**:告警画面截图保留天数、自动获取截图开关。
|
||||
|
||||
* **权限要求**:**(注:仅对 OCC 车站的操作员可见)**。
|
||||
|
||||
## 阶段五:日志管理模块
|
||||
|
||||
**涉及模块**:`Log`
|
||||
|
||||
1. **子模块:上级调用日志 (Call Log)**
|
||||
|
||||
* **查询**:筛选车站(受查看权限限制)、日志类型(如视频点播、云台指令)、时间范围。
|
||||
|
||||
* **导出**:导出查询结果。
|
||||
|
||||
2. **子模块:视频平台日志 (Vimp Log)**
|
||||
|
||||
* **查询**:筛选车站(受查看权限限制)、内部操作类型、时间范围。
|
||||
|
||||
* **导出**:导出查询结果。
|
||||
|
||||
## 阶段六:权限管理模块
|
||||
|
||||
**涉及模块**:`Permission`
|
||||
|
||||
**(注:本模块仅对“超级管理员”可见,普通用户无法访问)**
|
||||
|
||||
1. **用户列表管理**
|
||||
|
||||
* **搜索**:通过真实姓名查找用户。
|
||||
|
||||
* **重置**:清空搜索条件。
|
||||
|
||||
2. **权限配置 (Permission Config)**
|
||||
|
||||
* **矩阵式界面**:
|
||||
|
||||
* **行**:对应各个车站。
|
||||
|
||||
* **列**:对应具体权限类型(如查看、操作)。
|
||||
|
||||
* **批量操作**:支持整行(单站全权)或整列(全站某权)一键勾选。
|
||||
|
||||
* **特殊规则说明**:若未给用户勾选任何权限,平台默认该用户拥有**所有权限**(超级管理员模式)。
|
||||
|
||||
Reference in New Issue
Block a user