1 引言

1.1 编写目的：阐明编写手册的目的，指明读者对象。

1.2 项目背景：说明项目的来源、委托单位、开发单位及和主管部门。

1.3 定义：列出手册中使用的专门术语的定义和缩写词的愿意。

1.4 参考资料：1.列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源2.项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划3.文档中所引用的其他资料、采用的软件工程标准或软件工程规范。

2 软件概述

2.1 目标2.2 功能2.3 性能2.4 数据精确度2.5 时间特性：如响应时间、处理时间、数据传输时间等。2.6 灵活性在操作方式、运行环境需做某些变更时软件的适应能力。

3 运行环境

3.1 硬件1.列出软件系统运行时所需的硬件最小配置，如计算机型号、主存容量2.外存储器、媒体、记录格式、设备型号及数量3. 输入、输出设备4.数据传输设备及数据转换设备的型号及数量。

3.2 支持软件，1.操作系统名称及版本号；2.语言编译系统或汇编系统的名称及版本号；3.数据库管理系统的名称及版本号；4.其他必要的支持软件

4 使用说明

4.1 安装和初始化：给出程序的存储形式、操作命令、反馈信息及其做含意、表明安装完成的测试实例以及安装所需的软件工具等。4.2 输入：给出输入数据或参数的要求。3.数据背景：说明数据来源、存储媒体、出现频度、限制和质量管理等。2.数据格式:如长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。3.输入举例。4.3 输出：给出每项输出数据的说明。1.数据背景：说明输出数据的去向、使用频度、存放媒体及质量管理等。2.数据格式：详细阐明每一输出数据的格式，如首部、主体和尾部的具体形式。3. 举例4.4 出错和恢复：给出出错信息及其含意；用户应采取的措施，如修改、恢复、再启动。4.5 求助查询：说明如何操作。

5 运行说明

5.1 运行表：列出每种可能的运行情况，说明其运行目的。5.2 运行步骤：按顺序说明每和运行的步骤，应包括：5.3 运行控制5.4 操作信息：运行目的、运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项；5.5输入/输出文件：给出建立或更新文件的有关信息，如：文件的名称及编号；记录媒体；存留的目录；文件的支配：说明确定保留文件或废弃文件的准则，分发文件的对象，战胜硬件的优先级及保密控制等。

5.6 启动或恢复过程

6 非常规过程，提供应急戒非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作及维护人员须知的操作和注意事项。

7 操作命令一览表，按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

8 程序文件（或命令文件）和数据文件一览表，按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

9 用户操作举例