程序维护手册
1 概述
1.1 编写目的
“编写程序维护手册的目的是为程序维护人员有效的维护×××××(软件名称)系统提供必要的信息。”
1.2
如:
a. 用户手册;
b. 操作手册;
c. 与本项目有关的其它文档。
1.3
1.4 术语和缩写词 列出本文档中专用的术语、定义和缩写词。 开发单位
说明该项目的提出者、开发者、用户和运行该软件系统的场所。 参考资料 列出本文档引用到的参考资料,包括作者、来源、编号、标题、出版日期和保密级别。
2 系统说明
2.1 系统用途
说明系统具备的功能,如用于控制战斗的系统要接收专门的输入(如势态报告、紧急警报等)并从输入中提取一些数据,再由此导出一些数据,从而形成具体战斗任务的信息和简报。
2.2
2.3 安全保密 说明系统数据的安全保密考虑。 总体说明
根据系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的形式给出系统主要部分的内部关系。
2.4 程序说明
说明系统中每个程序、分程序的细节和特性,以帮助维护人员理解各个程序及它们之间的关系。系统的专用维护程序将在第4.5节(专用维护程序)中说明。
2.4.1 程序1(标识符)说明
2.4.1.1 功能
说明程序的功能
2.4.1.2 方法
说明实现该程序的功能所使用的方法。
2.4.1.3 输入
说明程序的输入、所用介质、运行时用到的数据记录、运行开始时使用的输入数据的类型及存放单元、与程序初始化有关的入口要求等。
2.4.1.4 处理
介绍程序维护人员需要了解的处理特点及目的,如:
a. 产要的运行,用图表说明该程序的一系列运行的逻辑流程,例如读一个输入,访问一个数据记录、一个判断和一次打印输出,这些运行可用程序内部的程序段或子程序来表示,也可用图表分别详细表示每个重要的运行;
b. 本程序的主要转移条件;
c. 对程序运行的约束条件;
d. 程序运行结束时的出口要求;
e. 与下个程序的通信和联接(运行、控制);
f. 由该程序产生并供处理程序段使用的输出数据类型及存放单元;
g. 程序运行需要的存储器容量、类型及存储位置等主要参数。
2.4.1.5 输出
用便于程序维护人员理解的方式说明该程序的输出。
2.4.1.6 接口
说明该程序与本系统其它部分的接口。
2.4.1.7 表格
说明程序内部的各种表、项的细节和特性,对每张表的说明至少包括:
a. 表的标识符;
b. 使用目的;
c. 使用此表的其它程序;
d. 逻辑划分,如块或部,不包括表项;
e. 基本结构,包括固定长或可变长、固定表目或可变表目;
f. 设计安排,包括表的控制信息、每类表目的结构细节、使用中的特有性质及表内各
项的标识符、位置信息、用途、类型及编码表示。
2.4.1.8 特有的运行性质
说明在操作手册中没有提到的运行性质。
2.4.2 程序2(标识符)说明
用与第2.4.1款相同的方法,说明第2个到第N 个程序。
3 操作环境
3.1
3.2
3.3
3.3.1 设备 逐项说明系统的设备配置及其特性。 支持软件 列出本系统使用的全部支持软件,包括它们的名称和版本号。 数据库 全面说明每个数据库的性质和内容,包括安全考虑。 总体特征
如:
a. 标识符;
b. 使用这些数据库的程序;
c. 静态数据;
d. 动态数据;
e. 数据库的存储介质(如磁带、磁盘和内存)的规格及容量;
f. 系统中程序使用数据库时受到的限制。
3.3.2 结构及详细说明
说明数据库的内部结构。
3.3.2.1 说明该数据库的结构,包括其中的记录和项。
3.3.2.2 说明一个物理记录是一个逻辑记录,还是组成一个逻辑记录的若干个物理记录之
一。说明一个记录的组成部分,如首部或控制段、记录体。
3.3.2.3 说明每个记录结构的域,需要时解释它的目的。对每个域应包括下述内容:
a. 标记或标号;
b. 指明每个数据域的字符长度和位数;
c. 指明该域的允许值范围。
3.3.2.4 扩充,说明为记录增添附加数据域的规定。
4 维护过程
4.1 约定
列出该软件系统设计中使用的全部规则和约定,包括:
a. 程序、分程序、记录、数据域和存储区的标识或标号助记符的使用规则;
b. 图表的处理和标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名;
c. 使用的软件技术标准;
d. 标准化的数据元素及其特征。
4.2 验证过程
说明一个程序段修改后,对其性能进行验证的要求和过程(包括测试程序和数据)及程序周期性验征的过程。
4.3
4.4 出错及纠正方法 列出出错状态及其纠正方法。 专门维护过程
说明本文档其它地方没有提到的专门维护过程,例如:
a. 维护该软件系统的输入输出部分(如数据库)的要求、过程和验证方法;
b. 运行程序库维护系统所必需的要求、过程和验证方法;
c. 对闰年、世纪变更需要的临时性修改等。
4.5 专用维护程序
列出维护软件系统使用的后备技术和专用程序(如文件恢复程序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:
a. 维护作业的输入输出要求;
b. 输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。
4.6
程序清单和流程图 引用资料或提供附录给出程序清单和流程图。
程序维护手册
1 概述 .................................................................................................................................... 1
1.1 编写目的 . ...................................................................................................................... 1
1.2 参考资料 . ...................................................................................................................... 1
1.3 术语和缩写词 . .............................................................................................................. 1
1.4 开发单位 . ...................................................................................................................... 1
2 系统说明 ............................................................................................................................ 1
2.1 系统用途 . ...................................................................................................................... 1
2.2 安全保密 . ...................................................................................................................... 1
2.3 总体说明 . ...................................................................................................................... 1
2.4 程序说明 . ...................................................................................................................... 1
2.4.1
2.4.2 程序1(标识符)说明 . ................................................................................... 1 程序2(标识符)说明 . ................................................................................... 2
3 操作环境 ............................................................................................................................ 2
3.1 设备 . .............................................................................................................................. 2
3.2 支持软件 . ...................................................................................................................... 2
3.3 数据库 . .......................................................................................................................... 2
3.3.1
3.3.2 总体特征 . .......................................................................................................... 2 结构及详细说明 . .............................................................................................. 3
4 维护过程 ............................................................................................................................ 3
4.1 约定 . .............................................................................................................................. 3
4.2 验证过程 . ...................................................................................................................... 3
4.3 出错及纠正方法 . .......................................................................................................... 3
4.4 专门维护过程 . .............................................................................................................. 3
4.5 专用维护程序 . .............................................................................................................. 3
4.6 程序清单和流程图 . ...................................................................................................... 3
程序维护手册
1 概述
1.1 编写目的
“编写程序维护手册的目的是为程序维护人员有效的维护×××××(软件名称)系统提供必要的信息。”
1.2
如:
a. 用户手册;
b. 操作手册;
c. 与本项目有关的其它文档。
1.3
1.4 术语和缩写词 列出本文档中专用的术语、定义和缩写词。 开发单位
说明该项目的提出者、开发者、用户和运行该软件系统的场所。 参考资料 列出本文档引用到的参考资料,包括作者、来源、编号、标题、出版日期和保密级别。
2 系统说明
2.1 系统用途
说明系统具备的功能,如用于控制战斗的系统要接收专门的输入(如势态报告、紧急警报等)并从输入中提取一些数据,再由此导出一些数据,从而形成具体战斗任务的信息和简报。
2.2
2.3 安全保密 说明系统数据的安全保密考虑。 总体说明
根据系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的形式给出系统主要部分的内部关系。
2.4 程序说明
说明系统中每个程序、分程序的细节和特性,以帮助维护人员理解各个程序及它们之间的关系。系统的专用维护程序将在第4.5节(专用维护程序)中说明。
2.4.1 程序1(标识符)说明
2.4.1.1 功能
说明程序的功能
2.4.1.2 方法
说明实现该程序的功能所使用的方法。
2.4.1.3 输入
说明程序的输入、所用介质、运行时用到的数据记录、运行开始时使用的输入数据的类型及存放单元、与程序初始化有关的入口要求等。
2.4.1.4 处理
介绍程序维护人员需要了解的处理特点及目的,如:
a. 产要的运行,用图表说明该程序的一系列运行的逻辑流程,例如读一个输入,访问一个数据记录、一个判断和一次打印输出,这些运行可用程序内部的程序段或子程序来表示,也可用图表分别详细表示每个重要的运行;
b. 本程序的主要转移条件;
c. 对程序运行的约束条件;
d. 程序运行结束时的出口要求;
e. 与下个程序的通信和联接(运行、控制);
f. 由该程序产生并供处理程序段使用的输出数据类型及存放单元;
g. 程序运行需要的存储器容量、类型及存储位置等主要参数。
2.4.1.5 输出
用便于程序维护人员理解的方式说明该程序的输出。
2.4.1.6 接口
说明该程序与本系统其它部分的接口。
2.4.1.7 表格
说明程序内部的各种表、项的细节和特性,对每张表的说明至少包括:
a. 表的标识符;
b. 使用目的;
c. 使用此表的其它程序;
d. 逻辑划分,如块或部,不包括表项;
e. 基本结构,包括固定长或可变长、固定表目或可变表目;
f. 设计安排,包括表的控制信息、每类表目的结构细节、使用中的特有性质及表内各
项的标识符、位置信息、用途、类型及编码表示。
2.4.1.8 特有的运行性质
说明在操作手册中没有提到的运行性质。
2.4.2 程序2(标识符)说明
用与第2.4.1款相同的方法,说明第2个到第N 个程序。
3 操作环境
3.1
3.2
3.3
3.3.1 设备 逐项说明系统的设备配置及其特性。 支持软件 列出本系统使用的全部支持软件,包括它们的名称和版本号。 数据库 全面说明每个数据库的性质和内容,包括安全考虑。 总体特征
如:
a. 标识符;
b. 使用这些数据库的程序;
c. 静态数据;
d. 动态数据;
e. 数据库的存储介质(如磁带、磁盘和内存)的规格及容量;
f. 系统中程序使用数据库时受到的限制。
3.3.2 结构及详细说明
说明数据库的内部结构。
3.3.2.1 说明该数据库的结构,包括其中的记录和项。
3.3.2.2 说明一个物理记录是一个逻辑记录,还是组成一个逻辑记录的若干个物理记录之
一。说明一个记录的组成部分,如首部或控制段、记录体。
3.3.2.3 说明每个记录结构的域,需要时解释它的目的。对每个域应包括下述内容:
a. 标记或标号;
b. 指明每个数据域的字符长度和位数;
c. 指明该域的允许值范围。
3.3.2.4 扩充,说明为记录增添附加数据域的规定。
4 维护过程
4.1 约定
列出该软件系统设计中使用的全部规则和约定,包括:
a. 程序、分程序、记录、数据域和存储区的标识或标号助记符的使用规则;
b. 图表的处理和标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名;
c. 使用的软件技术标准;
d. 标准化的数据元素及其特征。
4.2 验证过程
说明一个程序段修改后,对其性能进行验证的要求和过程(包括测试程序和数据)及程序周期性验征的过程。
4.3
4.4 出错及纠正方法 列出出错状态及其纠正方法。 专门维护过程
说明本文档其它地方没有提到的专门维护过程,例如:
a. 维护该软件系统的输入输出部分(如数据库)的要求、过程和验证方法;
b. 运行程序库维护系统所必需的要求、过程和验证方法;
c. 对闰年、世纪变更需要的临时性修改等。
4.5 专用维护程序
列出维护软件系统使用的后备技术和专用程序(如文件恢复程序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:
a. 维护作业的输入输出要求;
b. 输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。
4.6
程序清单和流程图 引用资料或提供附录给出程序清单和流程图。
程序维护手册
1 概述 .................................................................................................................................... 1
1.1 编写目的 . ...................................................................................................................... 1
1.2 参考资料 . ...................................................................................................................... 1
1.3 术语和缩写词 . .............................................................................................................. 1
1.4 开发单位 . ...................................................................................................................... 1
2 系统说明 ............................................................................................................................ 1
2.1 系统用途 . ...................................................................................................................... 1
2.2 安全保密 . ...................................................................................................................... 1
2.3 总体说明 . ...................................................................................................................... 1
2.4 程序说明 . ...................................................................................................................... 1
2.4.1
2.4.2 程序1(标识符)说明 . ................................................................................... 1 程序2(标识符)说明 . ................................................................................... 2
3 操作环境 ............................................................................................................................ 2
3.1 设备 . .............................................................................................................................. 2
3.2 支持软件 . ...................................................................................................................... 2
3.3 数据库 . .......................................................................................................................... 2
3.3.1
3.3.2 总体特征 . .......................................................................................................... 2 结构及详细说明 . .............................................................................................. 3
4 维护过程 ............................................................................................................................ 3
4.1 约定 . .............................................................................................................................. 3
4.2 验证过程 . ...................................................................................................................... 3
4.3 出错及纠正方法 . .......................................................................................................... 3
4.4 专门维护过程 . .............................................................................................................. 3
4.5 专用维护程序 . .............................................................................................................. 3
4.6 程序清单和流程图 . ...................................................................................................... 3