软件开发种13中文档 - 概要设计说明书

2021-11-01 15:01:39  晓掌柜  版权声明:本文为站长原创文章,转载请写明出处


一、前言

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

        ① 可行性分析报告

        ② 项目开发计划

        ③ 软件需求说明书

        ④ 概要设计说明书

        ⑤ 详细设计说明书

        ⑥ 用户操作手册

        ⑦ 测试计划

        ⑧ 测试分析报告

        ⑨ 开发进度月报

        ⑩ 项目开发总结报告

        ①① 软件维护手册

        ①② 软件问题报告

        ①③ 软件修改报告

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

二、概要设计说明书描述

    该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。

三、格式要求

    1 引言

        1.1 写目的:阐明编写概要设计说明书的目的,指明读者对象。 

        1.2 项目背景:应包括 

            ● 项目的委托单位、开发单位和主管部门 

            ● 该软件系统与其他系统的关系。 

        1.3 定义:列出本文档中所用到的专门术语的定义和缩写词的愿意。 

        1.4 参考资料: 

            ● 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源 

            ●项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;测试计划(初稿);用户操作手册 

            ● 文档所引用的资料、采用的标准或规范。 

    2 任务概述 

        2.1 目标 

        2.2 需求概述 

        2.3 条件与限制 

    3 总体设计 

        3.1 总体结构和模块外部设计 

        3.2 功能分配:表明各项功能与程序结构的关系。 

    4 接口设计 

        4.1 外部接口:包括用户界面、软件接口与硬件接口。 

        4.2 内部接口:模块之间的接口。 

    5 数据结构设计 

    6 逻辑结构设计 

        所有文档的统一封面格式如下页所示。 

    7 物理结构设计 

    8 数据结构与程序的关系 

    9 运行设计 

        9.1 运行模块的组合 

        9.2 运行控制 

        9.3 运行时间 

    10 出错处理设计 

        10.1 出错输出信息 

        10.2 出错处理对策:如设置后备、性能降级、恢复及再启动等。 

    11 安全保密设计 

    12 维护设计 

        说明为方便维护工作的设施,如维护模块等。





最新评论: