用户手册模板模板.doc

1引言21.1编写目标21.2背景21.3定义21.4参考资料22用途22.1功效22.2性能32.2.1精度32.2.2时间特征32.2.3灵活性32.3安全保密33运行环境33.1硬设备33.2支持软件33.3数据结构44使用过程44.1安装和初始化44.2输入44.2.1输入数据现实背景44.2.2输入格式44.2.3输入举例54.3输出对每项输出作出说明54.3.1输出数据现实背景54.3.2输出格式54.3.3输出举例54.4文卷查询64.5犯错处理和恢复64.6终端操作6用户手册（GB856788）1引言1.1编写目标说明编写这份用户手册目标，指出预期读者。 1.2背景说明：a. 这份用户手册所描述软件系统名称；b. 该软件项目标任务提出者、开发者、用户（或首批用户）及安装此软件计算中心。1.3定义列出本文件中用到专门术语定义和外文首字母组词原词组。1.4参考资料列出有用参考资料，如：a. 项目标经核准计划任务书或协议、上级机关批文；b. 属于本项目标其它已发表文件；c. 本文件中各处引用文件、资料，包含所要用到软件开发标准。列出这些文件资料标题、文件编号、发表日期和出版单位，说明能够取得这些文件资料起源。2用途2.1功效结合本软件开发目标逐项地说明本软件所含有各项功效和它们极限范围。2.2性能2.2.1精度逐项说明对各项输入数据精度要求和本软件输出数据达成精度，包含传输中精度要求。2.2.2时间特征定量地说明本软件时间特征，如响应时间，更新处理时间，数据传输、转换时间，计算时间等。2.2.3灵活性说明本软件所含有灵活性，即当用户需求（如对操作方法、运行环境、结果精度、时间特征等要求）有一些改变时，本软件适应能力。2.3安全保密说明本软件在安全、保密方面设计考虑和实际达成能力。3运行环境3.1硬设备列出为运行本软件所要求硬设备最小配置，如：a. 处理机型号、内存容量；b. 所要求外存放器、媒体、统计格式、设备型号和台数、联机脱机；c. IO设备（联机脱机？）；d. 数据传输设备和转换设备型号、台数。3.2支持软件说明为运行本软件所需要支持软件，如：a 操作系统名称、版本号；b 程序语言编译汇编系统名称和版本号；c 数据库管理系统名称和版本号；d 其它支持软件。3.3数据结构列出为支持本软件运行所需要数据库或数据文卷。4使用过程在本章，首先用图表形式说明软件功效同系统输入源机构、输出接收机构之间关系。4.1安装和初始化一步一步地说明为使用本软件而需进行安装和初始化过程，包含程序存放形式、安装和初始化过程中全部操作命令、系统对这些命令反应和回复。表征安装工作完成测试实例等。假如有话，还应说明安装过程中所需用到专用软件。4.2输入要求输入数据和参量准备要求。4.2.1输入数据现实背景说明输入数据现实背景，关键是a. 情况比如人员变动、库存缺货；b. 情况出现频度比如是周期性、随机、一项操作状态函数；c. 情况起源一比如人事部门、仓库管理部门；d. 输入媒体比如键盘、穿孔卡片、磁带；e. 限制出于安全、保密考虑而对访问这些输入数据所加限制；f. 质量管理比如对输入数据合理性检验和当输入数据有错误时应采取方法，如建立犯错情况统计等；g. 支配比如怎样确定输入数据是保留还是废弃，是否要分配给其它接收者等。4.2.2输入格式说明对初始输入数据和参量格式要求，包含语法规则和相关约定，如：a. 长度一比如字符数行，字符数项；b. 格式基准比如以左面边缘为基准；c. 标号比如标识或标识符；d. 次序比如各个数据项次序及位置；e. 标点比如用来表示行、数据组等开始或结束而使用空格、斜线、星号、字符组等。f. 词汇表给出许可使用字符组合列表，严禁使用字符组合列表等；g. 省略和反复给出用来表示输人元素可省略或反复表示方法；h. 控制给出用来表示输入开始或结束控制信息。4.2.3输入举例为每个完整输入形式提供样本，包含：a 控制或首部比如用来表示输入种类和类型信息，标识符输入日期，正文起点和对所用编码要求；b 主体输入数据主体，包含数据文卷输入表述部分；c 尾部用来表示输入结束控制信息，累计字符总数等；d 省略指出哪些输入数据是可省略；e 反复指出哪些输入数据是反复。4.3输出对每项输出作出说明4.3.1输出数据现实背景说明输出数据现实背景，关键是：a 使用这些输出数据是给谁，用来干什么；b 使用频度比如每七天、定时或备查阅；c 媒体打印、CRI显示、磁带、卡片、磁盘，d 质量管理一比如相关合理性检验、犯错纠正要求；e 支配比如怎样确定输出数据是保留还是废弃，是否要分配给其它接收者等。4.3.2输出格式给出对每一类输出信息解释，关键是：a 首部如输出数据标识符，输出日期和输出编号；b 主体输出信息主体，包含分栏标题；c 尾部包含累计总数，结束标识。4.3.3输出举例为每种输出类型提供例子。对例子中每一项，说明：a 定义每项输出信息意义和用途；b 起源是从特定输入中抽出、从数据库文卷中取出、或从软件计算过程中得到；c 特征输出值域、计量单位、在什么情况下可缺省等。4.4文卷查询这一条编写针对含有查询能力软件，内容包含：同数据库查询相关初始化、准备、及处理所需 要具体要求，说明查询能力、方法，所使用命令和所要求控制要求。4.5犯错处理和恢复列出由软件产生犯错编码或条件和应由用户负担修改纠正工作。指出为了确保再开启和恢复能力，用户必需遵照处理过程。4.6终端操作当软件是在多终端系统上工作时，应编写本条，以说明终端配置安排、连接步释、数据和参数输入步骤和控制要求说明经过终端操作进行查询、检索、修改数据文卷能力、语言、过程和辅助性程序等。