软件综合项目程序维护基础手册模版.doc

十一、程序维护手册1引言11.1编写目标11.2开发单位11.3定义21.4参考资料22系统说明22.1系统用途22.2安全保密22.3总体说明22.4程序说明23操作环境33.1设备33.2支持软件33.3数据库34维护过程34.1约定34.2验证过程34.3犯错及纠正方法34.4专门维护过程34.5专用维护程序34.6程序清单和步骤图31引言1.1编写目标【说明编写手册目标，指明读者对象。】1.2开发单位【说明项目标提出者、开发者、用户和使用场所。】1.3定义【列出汇报中所用到专门术语定义和缩写词原文。】1.4参考资料【列出相关资料作者、标题、编号、发表日期、出版单位或资料起源，和保密等级，可包含： a. 用户操作手册；b. 和本项目相关其它文档。】2系统说明2.1系统用途【说明系统含有功效，输入和输出。】2.2安全保密【说明系统安全保密方面考虑。】2.3总体说明【说明系统总体功效，对系统、子系统和作业做出综合性介绍，并用图表方法给出系统关键部分内部关系。】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.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支持软件【列出系统使用支持软件，包含它们名称和版本号。】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约定【列出该软件系统设计中所使用全部规则和约定，包含：a. 程序、分程序、统计、字段和存放区标识或标号助记符使用规则；b. 图表处理标准、卡片连接次序、语句和记号中使用缩写、出现在图表中符号名；c. 使用软件技术标准；d. 标准化数据元素及其特征。】4.2验证过程【说明一个程序段修改后，对其进行验证要求和过程（包含测试程序和数据）及程序周期性验证过程。】4.3犯错及纠正方法【列出犯错状态及其纠正方法。】4.4专门维护过程【说明文档其它地方没有提到专门维护过程，如：a. 维护该软件系统输入输出部分（如数据库）要求、过程和验证方法；b. 运行程序库维护系统所必需要求、过程和验证方法；c. 对闰年、世纪变更所需临时性修改等。】4.5专用维护程序【列出维护软件系统使用后备技术和专用程序（如文件恢复程序、淘汰过时文件程序等）目录，并加以说明，内容包含：a. 维护作业输入输出要求； b. 输入具体过程及在硬设备上建立、运行并完成维护作业操作步骤。】4.6程序清单和步骤图【引用资料或提供附录给出程序清单和步骤图。】