软件使用手册模板.doc

_部门： 项目： 密级： 日期： 项目名称用户操作手册9-12_编写说明类别：项目文档密级：撰稿人：修改人：存放位置：编辑软件：版本信息：版本修改点说明目录1引言1-11.1编写目的1-11.2项目背景1-11.3术语定义1-11.4参考资料1-12软件概述2-32.1目标2-32.2功能2-32.3性能2-33运行环境3-43.1硬件3-43.2支持软件3-44使用说明4-54.1安装和初始化4-54.2输入4-54.2.1数据背景4-54.2.2数据格式4-54.2.3输入举例4-64.3输出4-64.3.1数据背景4-64.3.2数据格式4-64.3.3举例4-64.4出错和恢复4-64.5求助查询4-65运行说明5-75.1运行表5-75.2运行步骤5-75.2.1运行控制5-75.2.2操作信息5-75.2.3输入输出文件5-75.2.4启动或恢复过程5-86非常规过程6-97操作命令一览表6-108程序文件(或命令文件)和数据文件一览表6-119用户操作举例6-121 引言1.1 编写目的阐明编写手册的目的，指明读者对象。1.2 项目背景说明项目来源、委托单位、开发单位及主管部门。1.3 术语定义列出手册中使用的专门术语的定义和缩写词的原意。序号缩略语说明/定义英文全称中文译名1.4 参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a 项目的计划任务书、合同或批文；b 项目开发计划；c 需求规格说明书；d 概要设计说明书；e 详细设计说明书；f 测试计划；g 手册中引用的其他资料、采用的软件工程标准或软件工程规范。文档编号文档名称作者/修订者版本号备注n 其它编号文档名称作者/修订者发布日期出版单位备注2 软件概述2.1 目标2.2 功能2.3 性能a. 数据精确度 包括输入、输出及处理数据的精度b. 时间特性 如响应时间、处理时间、数据传输时间等c. 灵活性 在操作方式、运行环境需做某些变更时软件的适应能力3 运行环境3.1 硬件列出软件系统运行时所需的硬件最小配置，如a 计算机型号、主存容量b 外存储器、媒体、记录格式、设备型号及数量；c 输入、输出设备；d 数据传输设备及数据转换设备的型号及数量。3.2 支持软件a. 操作系统名称及版本号；b. 语言编译系统或汇编系统的名称及版本号；c. 数据库管理系统的名称及版本号；d. 其他必要的支持软件； 4 使用说明4.1 安装和初始化给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。4.2 输入给出输入数据或参数的要求。4.2.1 数据背景说明数据来源、存储媒体、出现频度、限制和质量管理等。4.2.2 数据格式如：a 长度；b 格式基准；c 标号；d 顺序；e 分隔符；f 词汇表；g 省赂和重复；h 控制4.2.3 输入举例4.3 输出给出每项输出数据的说明4.3.1 数据背景说明输出数据的去向、使用频度、存放媒体及质量管理等。4.3.2 数据格式详细阐明每一输出数据的格式，如：首部、主体和尾部的具体形式。4.3.3 举例4.4 出错和恢复给出：a 出错信息及其含意；b 用户应采取的措施，如修改、恢复、再启动。4.5 求助查询说明如何操作。5 运行说明5.1 运行表列出每种可能的运行情况，说明其运行目的。5.2 运行步骤按顺序说明每种运行的步骤，应包括以下步骤：5.2.1 运行控制5.2.2 操作信息a 运行目的；b 操作要求；c 启动方法；d 预计运行时间；e 操作命令格式及说明；f 其他事项。5.2.3 输入输出文件给出建立或更新文件的有关信息，如：a. 文件的名称及编号；b. 记录媒体；c. 文件的保存目录；d. 文件的支配 说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等。5.2.4 启动或恢复过程6 非常规过程提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。7 操作命令一览表按字母顺序逐个列出全部操作命令的格式、功能及参数说明。8 程序文件(或命令文件)和数据文件一览表按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。9 用户操作举例