TAG:
|
1 引言 1.1 编写目的：阐明编写总结报告的目的并指明读者对象。 1.2 项目背景：说明项目的来源、委托单位、开发单位及主管部门。 1.3 定义：列出报告中所用到的专门术语的定义和缩写词的原意。 1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告；本报告引用的其他资料、采用的开发标准或开发规范。 2 开发结果 2.1 产品：可包括列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。 2.2 主要功能及性能 2.3 所用工时：按人员的不同层次分别计时。 2.4 所用机时：按所用计算机机型分别计时。 2.5 进度：给出计划进度与实际进度的对比。 2.6 费用 3 评价 3.1 生产率评价：如平均每人每月生产的源程序行数、文档的字数等。 3.2 技术方案评价 3.3 产品质量评价 4 经验与教训软件维护手册 1 引言 1.1 编写目的：阐明编写手册的目的并指明读者对象。 1.2 项目背景：说明项目的提出者、开发者、用户和使用场所。 1.3 定义：列出报告中所用到的专门术语的定义和缩写词的原意。 1.4 参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，及保密级别，可包括：用户操作手册；与本项目有关的其他文档。 2 系统说明 2.1 系统用途：说明系统具备的功能，输入和输出。 2.2 安全保密：说明系统安全保密方面的考虑。 2.3 总体说明：说明系统的总体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要部分的内部关系。 2.4 程序说明：说明系统中每一程序、分程序的细节和特性。 2.4.1 程序1的说明●功能：说明程序的功能。 ●方法：说明实现方法。 ●输入：说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。 ●处理：处理特点和目的，如：用图表说明程序的运行的逻辑流程；程序主要转移条件；对程序的约束条件；程序结束时的出口要求；与下一个程序的通信与联结（运行、控制）；由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元；程序运行存储量、类型及存储位置等。 ●输出：程序的输出。 ●接口：本程序与本系统其他部分的接口。 ●表格：说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括：表的标识符；使用目的；使用此表的其他程序；逻辑划分，如块或部，不包括表项；表的基本结构；设计安排，包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。 ●特有的运行性质：说明在用户操作手册中没有提到的运行性质。 2.4.2程序2的说明与程序1的说明相同。以后的其他各程序的说明相同。 3 操作环境 3.1 设备：逐项说明系统的设备配置及其特性。 3.2 支持软件：列出系统使用的支持软件，包括它们的名称和版本号。 3.3 数据库：说明每个数据库的性质和内容，包括安全考虑。 3.3.1总体特征：如标识符、使用这些数据库的程序、静态数据、动态数据；数据库的存储媒体；程序使用数据库的限制。 3.3.2结构及详细说明●说明该数据库的结构，包括其中的记录和项。 ●说明记录的组成，包括首部或控制段、记录体。 ●说明每个记录结构的字段，包括：标记或标号、字段的字符长度和位数、该字段的允许值范围。 ●扩充：说明为记录追加字段的规定。 4 维护过程 4.1 约定：列出该软件系统设计中所使用全部规则和约定，包括：程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则；图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名；使用的软件技术标准；标准化的数据元素及其特征。 4.2 验证过程：说明一个程序段修改后，对其进行验证的要求和过程（包括测试程序和数据）及程序周期性验证的过程。 4.3 出错及纠正方法：列出出错状态及其纠正方法。 4.4 专门维护过程：说明文档其他地方没有提到的专门维护过程。如：维护该软件系统的输入输出部分（如数据库）的要求、过程和验证方法；运行程序库维护系统所必需的要求、过程和验证方法；对闰年、世纪变更的所需要的临时性修改等。 4.5 专用维护程序：列出维护软件系统使用的后备技术和专用程序（如文件恢复程序、淘汰过时文件的程序等）的目录，并加以说明，内容包括：维护作业的输入输出要求；输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。 4.6 程序清单和流程图：引用或提供附录给出程序清单和流程图。 软件问题报告 1 登记号由软件配置管理部门为该报告规定一个唯一的、顺序的编号。 2 登记日期软件配置管理部门登记该报告的日期。 3 问题发现日期发现该问题的日期和时间。 4 活动在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。 5 状态在软件配置记录中维护的动态指示，状态表示有：正在复查"软件问题报告"，以确定将采取什么行动；"软件问题报告"已由指定的人去进行处理；修改已完成，并经过测试，正准备交给主程序库；主程序库已经更新，主程序库修改的重新测试沿未完成；做了重新测试，问题再现；做了重新测试，所做的修改无故障，"软件问题报告"被关闭；留待以后关闭。 6 报告人填写"软件问题报告"人员的姓名、地址、电话。 7 问题属于什么方面区分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。也可能是它们的某种组合。 8 模块/子系统出现的模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。 9 修订版本号出现问题的模块版本。 10 磁带包含有问题的模块的主程序库的磁带的标识符。 11 数据库当发现问题时所使用数据库的标识符。 12 文件号有错误的文件的编号。 13 测试用例发现错误时所使用测试用例的标识符。 14 硬件发现错误时所使用的计算机系统的标识。 15 问题描述/影响问题症兆的详细描述。如果可能，则写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等的影响。 16 附注记载补充信息。 软件修改报告 1 登记号由软件配置管理部门为该报告规定的编号。 2 登记日期软件配置管理部门登记"软件修改报告"的日期。 3 时间准备好"软件修改报告"的日期。 4 报告人填写该报告的作者。 5 子系统名受修改影响的子系统名。 6 模块名被修改的模块名。 7 "软件问题报告"的编号被"软件修改报告"处理或部分处理的"软件问题报告"的编号。如果某"软件问题报告"的问题只是部分被处理，则在编号后附以p，如1234p。 8 修改包括程序修改、文件更新、数据库修改或它们的组合。 9 修改描述修改的详细描述。如果是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请的标识符。 10 批准人批准人签字，正式批准进行修改。 11 语句类型程序修改中涉及到的语句类型，包括：输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类（如数据传送、存取语句类）。 12 程序名被修改的程序、文件或数据库的名字。 13 老修订版当前的版本/修订本标识。 14 新修订版修改后的版本/修订本标识。 15 数据库如果申请数据库修改，则给出数据库的标识符。 16 数据库修改报告数据库修改申请号。 17 文件如果要求对文件进行修改，则给出文件的名字。 18 文件更新文件更新通知单的编号。 19 修改是否已测试指出已对修改做了哪些测试，如单元、子系统、组装、确认和运行测试等，并注明测试成功与否。 20 "软件问题报告"是否给出问题的准确描述回答''是''或''否''。 21 问题注释准确地叙述要维护的问题。 22 问题源指明问题来自于哪里，如软件需求说明书、设计说明书、数据库、源程序等。 23 资源完成修改所需资源的估计，即总的人时数和计算机时间的开销。 (iwgh) |