引言1编写目的【阐明编写手册的目的,指明读者对象。】2项目背景【说明项目来源、委托单位、开发单位及主管部门。】3定义【列出手册中使用的专门术语的定义和缩写词的原意。】4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:项目的计划任务书、合同或批文项目开发计划需求规格说明书;概要设计说明书;详细设计说明书;测试计划;手册中引用的其他资料、采用的软件工程标准或软件工程规范。】软件概述1目标2功能3性能数据精确度【包括输入、输出及处理数据的精度。】时间特性【如响应时间、处理时间、数据传输时间等。】灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。】运行环境1硬件【列出软件系统运行时所需的硬件最小配置,如计算机型号、主存容量外存储器、媒体、记录格式、设备型号及数量输入、输出设备;数据传输设备及数据转换设备的型号及数量。】2支持软件【如:操作系统名称及版本号语言编译系统或汇编系统的名称及版本号;数据库管理系统的名称及版本号;其他必要的支持软件。】使用说明1安装和初始化【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。】2输入【给出输入数据或参数的要求。】1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。】2数据格式【如长度格式基准;标号;顺序;分隔符;词汇表;省略和重复;控制。】3输入举例3输出【给出每项输出数据的说明。】1数据背景【说明输出数据的去向、使用频度、存放媒体及质量管理等。】2数据格式【详细阐明每一输出数据的格式,如:首部、主体和尾部的具体形式。】3举例4出错和恢复【给出:出错信息及其含意用户应采取的措施,如修改、恢复、再启动。】5求助查询【说明如何操作。】运行说明1运行表【列出每种可能的运行情况,说明其运行目的。】2运行步骤【按顺序说明每种运行的步骤,应包括:】1运行控制2操作信息运行目的操作要求;启动方法;预计运行时间;操作命令格式及说明;其他事项。3输入/输出文件【给出建立或更新文件的有关信息,如:】文件的名称及编号记录媒体存留的目录;文件的支配【说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先级及保密控制等。】4启动或恢复过程