系统用户操作手册格式.docVIP

XX系统用户操作手册 变更记录 序号 变更内容 提出人 修改人 修改日期 版本 目录 一、 引言 4 §1. 编写目的 4 §2. 术语 4 §3. 用户注意事项 4 二、 运行环境 4 §1. 硬件及操作系统 4 §2. 其它 4 三、 安装 4 四、 系统概要 5 §1. 软件结构图 5 §2. 关联系统 5 §3. 数据处理 5 §4. 程序表 5 五、 使用说明 5 §1. 功能模块一 5 §2. 功能模块二 7 §3. …… 7 六、 附件 7 七、 维护 7  引言 编写目的 【本文档的编写目的，阅读者】 术语 【本文档使用的术语或缩写，这里只是针对文档全局使用的术语，功能模块说明中使用的术语在各功能模块描述。】 用户注意事项 【使用本软件的用户应该注意的重要事项，如“只有经过授权的用户才能访问XX数据”】 运行环境 硬件及操作系统 其它 【是否还有其它运行环境上的要求，如“安装了MS OFFICE 2000以上版本”】 安装 【用户如何获得本软件，本软件如何安装，如何更新，如何获得用户名及密码，如何登录】 系统概要 软件结构图 【树状结构图】 关联系统 【简要描述本系统与其它系统有没有什么关系，从其它系统获得什么数据，向其它系统写入什么数据】 数据处理 【将整个系统看作一个整体，简要描写系统的输入、主要加工过程、输出】 使用说明 功能模块一 主要功能 【本功能模块主要实现了什么功能。一个功能模块往往指一个窗体，或别的】 术语 【在下文的描述中可能用到的术语，如屏幕中一些区域的命名，一些表述方法与业务不一致的词语等，可截屏描述】 程序表 程序名称 程序标题 触发事件 主要功能 【程序表：属于本功能模块，用户可以直接运行的程序清单，最常见的就是窗体上的那些按钮】 【程序名称：用户可以直接运行的程序的名称，一般以动词开头，如“打印库存报表”、“搜索生产单”等； 程序标题：在窗体上显示出来的名称，如“确定”、“开始计算”等，程序标题可能为空； 触发事件：什么情况触发本程序运行； 主要功能：简要描述本程序的主要功能。】 典型操作流程 【用户处理业务时一般按什么顺序执行这些程序。可能会有几种典型操作流程；一般可以截屏描述。例如一次典型的染色排缸操作包括“导入生产单”、“获得染批”、“上传数据至TIM”等程序。】 程序说明 程序一 触发事件 【什么情况触发本程序运行】 前提条件 【什么条件满足时才能执行本程序，或什么条件不满足时就不能不执行本程序。一般指用户输入的数据，或别的。】 正常运行时间估算 【一般可分这几种情况：“2秒以下”、“2-10秒”、“10-60秒”、“1-5分钟”、“5分钟以上”。如果在不同情况下运行时间差别很大，可分情况讨论】 程序输入 数据项列表 数据项 数据类型 规则 能否为空 出错提示 备注 【程序输入：运行本程序需要用户在界面上输入哪些数据】 【数据项：需要输入的数据字段，如“花号”、“船样交期”等； 数据类型：该数据项的数据类型，一般包括“文本”、“整数”、“小数”、“日期”、“布尔”等； 规则：输入的值应该符合什么规则，如“10≤X≤20”； 能否为空：程序运行时该数据项能否置空； 出错提示：当输入不合规则时系统是否给出出错提示，如何提示】 注意事项 【数据项列表中不便描述，需要用户注意的地方。如“XX数据项与YY数据项的和必需大于1000，除非ZZ数据项的值小于200”】 程序处理 【程序做了什么操作，应该从用户的角度描述程序的运行过程，注意避免使用太深奥的IT术语】 程序输出或成果 【程序运行完毕后输出什么，如“XX统计表”、“XX查询结果”；或者程序运行后有什么成果，如“在数据库中保存了XX数据”；程序运行成功或失败有没有什么提示，如何提示。】 程序运行流程 【简要描述程序的运行流程，包括在什么情况下调用什么过程、函数、存储过程。此处描述的主要读者应该是高级用户或维护程序员】 程序二 …… 功能模块二 …… 附件 【是否有培训文档、视频文件等，在此写明】 维护 系统维护人及联系方式 常见问题处理方法 集团有限公司