一、前置准备(操作前必做,避免卡壳)
1.1 工具清单
- 档案管理系统后台权限账号:需具备系统配置查看+操作日志导出+功能测试3项权限,没有的直接找系统管理员开通,不要自行尝试越权操作
- 工具:录屏软件(Win10/Win11自带Xbox Game Bar,按Win+G直接调出;Mac用自带QuickTime Player,点击文件-新建屏幕录制即可,无需额外下载)、文档编辑工具(飞书文档/腾讯文档/Word均可)、Chrome浏览器(版本100以上,自带控制台抓包功能)
- 基础素材:现有残缺的操作手册、系统最新版本号(在系统「关于」页面可直接查看,必须和当前使用版本一致,旧版本操作规则不适用)
1.2 前期排查项
先确认手册残缺的模块类型:功能操作类(比如归档流程怎么走)、配置类(比如怎么新增用户权限)、故障排查类(比如上传失败怎么处理),把缺失的模块列成清单,按使用频率从高到低排序,优先补全高频使用的模块。
二、分场景实操补全步骤(可直接照搬)
2.1 功能操作类手册补全(适配普通用户使用场景)
- 打开Chrome浏览器登录档案系统,按F12调出控制台,切换到「Network」面板,过滤选项选「Doc/XHR」,确保所有操作请求都能被捕获
- 按你列的高频功能清单,从第一个功能开始逐次操作,每做一步按Win+G启动录屏,每点击一个按钮后停留3秒,同时查看控制台是否有请求报错,有报错的单独截图标注
- 单个功能操作完成后停止录屏,把操作步骤拆解成「步骤1/步骤2/步骤3」的格式,每一步配操作截图,截图要把当前点击的按钮用红色框标注,避免用户找错位置
- 涉及到必填项的,要在步骤里标注(必填),比如:步骤1:点击左侧菜单栏「档案归集」按钮,选择「年度归档」选项,点击右上角「新建归档」按钮;步骤2:填写归档名称(必填,格式为「年度+部门+归档类型」,比如2024年行政部人事档案归档),上传附件(仅支持pdf/word格式,单文件不超过500M)
- 所有功能操作完成后,把每个功能的操作步骤按模块归类,比如「档案归集模块」「档案查询模块」「档案借阅模块」,统一整理成手册内容。
2.2 配置类操作手册补全(适配管理员使用场景)
配置类操作必须先在测试环境操作,确认没问题再写进手册,避免用户配置错误导致系统故障,步骤如下:
- 登录系统测试环境(如果没有测试环境,找系统管理员要沙箱账号,禁止在生产环境操作),进入「系统配置」页面
- 按缺失的配置项逐次操作,比如「新增用户权限配置」,操作过程中每修改一个配置项,先截图当前默认配置,再修改,修改后点击保存,刷新页面对比配置是否生效
- 每一个配置项要写明3部分内容:配置入口、配置项含义、生效规则,示例如下:
- 配置入口:系统管理-角色权限配置-新增角色
- 配置项含义:「档案删除权限」勾选后,该角色下的用户可以删除已归档的档案,默认不勾选
- 生效规则:配置完成后,对应用户重新登录系统即可生效,无需重启系统
- 所有配置操作完成后,导出系统配置项的完整清单:打开控制台,在Network面板找到获取配置列表的接口,右键选择「Copy response」,返回的配置json示例如下,把所有配置项整理成表格和操作步骤对应,避免遗漏:
```json
{
"configId": "1001",
"configName": "档案删除权限",
"defaultValue": "false",
"effectRule": "用户重新登录生效"
}
```
2.3 故障排查类手册补全(适配所有用户场景)
先导出近3个月的系统操作日志,路径:系统管理-操作日志-导出,时间范围选最近3个月,格式选Excel,然后按报错次数排序,优先整理高频报错的解决方案:
- 每个故障要写明3部分:故障现象、触发原因、解决方案,示例如下:
- 故障现象:上传档案时提示「文件格式不支持」
- 触发原因:当前上传的文件为exe/zip格式,系统仅支持pdf/word/excel/jpg/png格式
- 解决方案:把文件转成支持的格式后重新上传,单个文件超过500M的拆分后分批次上传
- 如果遇到日志里没有记录的故障,直接复现故障,在控制台的Network面板找到报错的请求,查看response里的报错码,去国家档案局官方发布的报错码对照表查对应解决方案,地址:https://www.narca.org.cn/xxgk/xxgkml/tzgg/202302/t20230217_58818.html
- 所有故障整理完成后,按报错频率排序,放在手册方便用户快速查找。
三、手册验证&更新规则(避免后续再出现不全问题)
3.1 手册有效性验证
补全后的手册要找3个不同角色的用户测试:普通用户、部门管理员、系统管理员,每个角色按手册操作10次高频功能,只要有1次操作失败,就立刻修改对应步骤,直到所有操作100%成功,验证通过后再正式发布。
3.2 后续更新规则

建立固定的手册更新机制,避免系统迭代后手册失效:
- 系统每次版本更新后3个工作日内,由系统管理员同步更新操作手册对应模块
- 每个月收集一次用户的手册使用反馈,有模糊或者缺失的部分24小时内更新
- 手册统一放在企业内部知识库的固定位置,设置权限为全员可见,禁止私自转发旧版本
四、常见卡壳问题解决
1. 没有系统管理员权限怎么办?直接找企业内部负责系统运维的人员申请,申请时说明是补全操作手册,一般24小时内都会审批通过,不要尝试破解权限,会触发系统安全告警。
2. 系统没有测试环境怎么办?可以新建一个临时测试账号,所有配置操作都在测试账号下完成,操作完成后删除测试账号即可,不要修改现有正式账号的配置。
3. 录屏的时候有敏感信息怎么办?用系统自带的画图工具把敏感信息(比如员工身份证号、手机号、涉密档案编号)打码后再放进手册,严禁泄露涉密信息。