软件手册(软件使用说明书)模板文章来源: http://blog.163.com/szy 1986 311 @ 126/blog/static/14108867320104395640517 /
1 .引言
1.1编写目的【明确手册编写的目的。 指出读者的对象。 】
1.2项目背景【说明项目来源、委托单位、开发单位及主管部门】
1.3定义【列举手册中使用的专业术语的定义和缩略语的原意】
1.4参考资料【列举有关资料的作者、标题、编号、发布日期、出版单位或资料来源,可包括: a .项目计划任务书、合同或批文; b .项目开发计划c .需求规格书d .概要设计说明书e。 详细设计说明书; f .测试计划g。 文档中引用的其他资料、采用的软件工程标准或软件工程规范。 】
2 .软件概述
2.1目标
2.2功能
2.3性能
a .数据精度【包括输入、输出及处理数据的精度】
b .时间特性【响应时间、处理时间、数据传输时间等。 】
c .灵活性【操作方法、操作环境需要进行某些变更时软件的适应能力。 】
3 .运行环境
3.1硬件【列举运行软件系统所需的最小硬件配置。 例如,a .计算机型号、主存储容量; b .外部存储器、介质、记录格式、设备型号及数量; C .输入输出设备d .数据传输设备及数据转换设备的型号及数量。 】
3.2支持软件【如a.OS名称和版本号; 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.l数据背景【说明输出数据的使用频率、存储介质及质量控制等。 】
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. 用户操作举例