软件程序维件护手册.docVIP

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