软件开发中13种文档 - 软件维护手册

2021-11-24 09:23:27  晓掌柜  版权声明:本文为站长原创文章,转载请写明出处


一、前言

    在项目开发过程中文档是很重要的一部分,一个完整的开发流程需要包含以下13种文档:

        ① 可行性分析报告

        ② 项目开发计划

        ③ 软件需求说明书

        ④ 概要设计说明书

        ⑤ 详细设计说明书

        ⑥ 用户操作手册

        ⑦ 测试计划

        ⑧ 测试分析报告

        ⑨ 开发进度月报

        ⑩ 项目开发总结报告

        ①① 软件维护手册

        ①② 软件问题报告

        ①③ 软件修改报告

    且上述十三种文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。下面我们就逐一对每个文档进行说明。

二、软件维护手册描述

    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 程序清单和流程图:引用或提供附录给出程序清单和流程图。



最新评论: