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