用户手册的内容

如题所述

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

温馨提示:答案为网友推荐,仅供参考
相似回答