《十一、程序维护手册(软件开发文档模板)(共5页).doc》由会员分享,可在线阅读,更多相关《十一、程序维护手册(软件开发文档模板)(共5页).doc(5页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、精选优质文档-倾情为你奉上十一、程序维护手册1引言1.1编写目的【阐明编写手册的目的,指明读者对象。】1.2开发单位【说明项目的提出者、开发者、用户和使用场所。】1.3定义【列出报告中所用到的专门术语的定义和缩写词的原文。】1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,以及保密级别,可包括: a. 用户操作手册;b. 与本项目有关的其他文档。】2系统说明2.1系统用途【说明系统具备的功能,输入和输出。】2.2安全保密【说明系统安全保密方面的考虑。】2.3总体说明【说明系统的总体功能,对系统、子系统和作业做出综合性的介绍,并用图表的方式给出系统主要部分的内部关系。
2、】2.4程序说明【说明系统中每一程序、分程序的细节和特性。】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
3、.1.5输出【程序的输出。】2.4.1.6接口【本程序与本系统其他部分的接口。】2.4.1.7表格【说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括:a. 表的标识符;b. 使用目的;c. 使用此表的其他程序;d. 逻辑划分,如块或部,不包括表项;e. 表的基本结构;f. 设计安排,包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。】2.4.1.8特有的运行性质【说明在用户操作手册中没有提到的运行性质。】2.4.2程序2的说明【与程序1的说明相同。以后其他各程序的说明相同。】3操作环境3.1设备【逐项说明系统的设备配置及其特性。】3.2支持
4、软件【列出系统使用的支持软件,包括它们的名称和版本号。】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说明每个记录结构的字段,包括:标记或标号、字段的字符长度和位数、该字段的充许值范围。3.3.2.4扩充:说明为记录追加字段的规定;4维护过程4.1约定【列出该软件系统设计中所使用全部规则
5、和约定,包括:a. 程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则;b. 图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名;c. 使用的软件技术标准;d. 标准化的数据元素及其特征。】4.2验证过程【说明一个程序段修改后,对其进行验证的要求和过程(包括测试程序和数据)及程序周期性验证的过程。】4.3出错及纠正方法【列出出错状态及其纠正方法。】4.4专门维护过程【说明文档其他地方没有提到的专门维护过程,如:a. 维护该软件系统的输入输出部分(如数据库)的要求、过程和验证方法;b. 运行程序库维护系统所必需的要求、过程和验证方法;c. 对闰年、世纪变更所需的临时性修改等。】4.5专用维护程序【列出维护软件系统使用的后备技术和专用程序(如文件恢复程序、淘汰过时文件的程序等)的目录,并加以说明,内容包括:a. 维护作业的输入输出要求; b. 输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。】4.6程序清单和流程图【引用资料或提供附录给出程序清单和流程图。】专心-专注-专业