设计文档?你还不会写设计文档?设计文档是什么?

详细设计文档包含概要设计文档的全部内容(不是绝对),也就是详细设计文档,其实是在概要设计文档的基础上进一步填充内容而得到的。

那为什么还要分概要设计和详细设计文档呢,以房子为例:开发商只开发毛坯房,那么此时整栋楼的设计文档就是概要设计文档。然后房子交到不同住户手上,不用的住户在已有的毛坯房的基础上进行装修设计,此时每一个住户都出一份房屋的装修设计文档,这些文档就是详细设计文档。把整栋楼的所有用户的详细设计文档补充进开发商的概要设计文档,就得出了整栋楼的详细设计文档。

也就说,详细设计文档出来后,概要设计文档就已经变得多余了。所以为什么不一开始就写一份详细设计文档就好了呢,何必多写一份概要设计文档。很简单,软件开发是有一定的过程的。我们不是为了写文档而写文档,而是开发的过程中要输出相应的文档。

接下来就以一个常规的软件开发流程来说明。如下图
在这里插入图片描述
这里主要简单谈下软件开发的开发过程,首先客户提出要开发一个软件,产品经理及相关人员进行了可行性分析过程,输出了《可行性分析文档》,项目经理及相关人员进行了需求分析过程,输出了《需求文档》和《原型图》,架构师根据《需求文档》和《原型图》进行了概要设计过程,输出了概要设计文档,此时,架构师或者相关人员可以根据《概要设计文档》进行项目的框架搭建,与此同时,架构师或者其他人员可以同步进行详细设计过程。

从这里可以看出,项目的框架搭建和详细设计过程是同步进行的,如果完全等详细设计文档出来,再进行项目框架的搭建,那么软件开发的周期就会变长,所以概要设计和详细设计的过程虽然可以归为一个过程,但是从分工合作以及进度的考虑,自然是拆分为2个过程。当然,实际开发过程中,详细设计文档并不完全包含概要设计文档。但是详细设计文档的整体结构肯定是与概要设计一致的,如果在详细设计中出现了概要设计中没有的模块,那么一定要及时将该模块补全进概要设计文档。

总之,为了便于理解,可以把概要设计文档的内容当做一个人的骨架,详细设计文档就是一个人,这就是概要设计文档和详细设计文档的关系。但是,要注意,现实中概要设计文档并不完全是详细设计文档的骨架。概要设计文档出来后,详细设计文档依据概要设计文档进行编写,总的原则是,详细设计文档的描述的模块都是从概要设计文档得来的,二者要统一。

需求文档、概要设计文档、详细设计文档怎么写、具体可以看我另外的博客

posted @ 2022-04-22 10:01  wnrun  阅读(403)  评论(0编辑  收藏  举报