设计文档?你还不会写设计文档?设计文档是什么?
详细设计文档包含概要设计文档的全部内容(不是绝对),也就是详细设计文档,其实是在概要设计文档的基础上进一步填充内容而得到的。
那为什么还要分概要设计和详细设计文档呢,以房子为例:开发商只开发毛坯房,那么此时整栋楼的设计文档就是概要设计文档。然后房子交到不同住户手上,不用的住户在已有的毛坯房的基础上进行装修设计,此时每一个住户都出一份房屋的装修设计文档,这些文档就是详细设计文档。把整栋楼的所有用户的详细设计文档补充进开发商的概要设计文档,就得出了整栋楼的详细设计文档。
也就说,详细设计文档出来后,概要设计文档就已经变得多余了。所以为什么不一开始就写一份详细设计文档就好了呢,何必多写一份概要设计文档。很简单,软件开发是有一定的过程的。我们不是为了写文档而写文档,而是开发的过程中要输出相应的文档。
接下来就以一个常规的软件开发流程来说明。如下图
这里主要简单谈下软件开发的开发过程,首先客户提出要开发一个软件,产品经理及相关人员进行了可行性分析过程,输出了《可行性分析文档》,项目经理及相关人员进行了需求分析过程,输出了《需求文档》和《原型图》,架构师根据《需求文档》和《原型图》进行了概要设计过程,输出了概要设计文档,此时,架构师或者相关人员可以根据《概要设计文档》进行项目的框架搭建,与此同时,架构师或者其他人员可以同步进行详细设计过程。
从这里可以看出,项目的框架搭建和详细设计过程是同步进行的,如果完全等详细设计文档出来,再进行项目框架的搭建,那么软件开发的周期就会变长,所以概要设计和详细设计的过程虽然可以归为一个过程,但是从分工合作以及进度的考虑,自然是拆分为2个过程。当然,实际开发过程中,详细设计文档并不完全包含概要设计文档。但是详细设计文档的整体结构肯定是与概要设计一致的,如果在详细设计中出现了概要设计中没有的模块,那么一定要及时将该模块补全进概要设计文档。
总之,为了便于理解,可以把概要设计文档的内容当做一个人的骨架,详细设计文档就是一个人,这就是概要设计文档和详细设计文档的关系。但是,要注意,现实中概要设计文档并不完全是详细设计文档的骨架。概要设计文档出来后,详细设计文档依据概要设计文档进行编写,总的原则是,详细设计文档的描述的模块都是从概要设计文档得来的,二者要统一。
需求文档、概要设计文档、详细设计文档怎么写、具体可以看我另外的博客
设计文档?你还不会写设计文档?设计文档是什么?相关推荐
- 还在发愁写API文档?推荐一款阿里腾讯都在用的API管理神器!
欢迎关注方志朋的博客,回复"666"获面试宝典 前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...
- 写word文档时计算机的工作原理,写word文档时还没保存电脑就死机如何恢复
电脑已经成为人类生活中不可缺少的一部分,人们利用电脑可以轻松的完成以前需要大量劳动力才能完成的工作,但在人们在使用电脑中也会遇到很多的麻烦,比如死机,这些原因烦恼着每一个电脑用户,这不,最近就有小伙伴 ...
- 用蚕茧表示法写简洁实用的接口文档
蚕茧表示法是一个接口描述的规范.我用它的一个典型的场景就是写内部接口文档.蚕茧法体现了两个思想: 使用简洁的语法来描述对象.数组.字典等复杂结构. 通过命名规范,让一个名字自发地体现出它的类型.如名词 ...
- 如何写出优秀的技术文档?
大家好,我是小枣君. 鲜枣课堂自从2017年5月开始正式创立,迄今已有3年多的时间.这一期间,我们的内容一直都坚持以技术类科普文章为主,输出了大约400多篇原创.其中绝大部分,都是我写的. 我的想法比 ...
- 商业需求文档(BRD)怎么写
BRD是英文"Business Requirement Document"的缩写,根据英文直译过来就是"商业需求文档"的意思,指的就是基于商业目标或价值所描述的 ...
- Python 文档,给自己的程序写文档
文档,这个词语在经常在程序员的嘴里冒出来,有时候他们还经常以文档有没有或者全不全为标准来衡量一个软件项目是否高大上.那么,软件中的文档是什么呢?有什么要求呢?python文档又是什么呢?文档有什么用呢 ...
- .net编写抽奖的文档_使用开源文档工具docsify,用写博客的姿势写文档
前提 ❝ 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 ❞ 「docsify」是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBoo ...
- linux 如何查看终端格式,你应该还不知道,Linux终端下的 Markdown 文档查看器
原标题:你应该还不知道,Linux终端下的 Markdown 文档查看器 现在,Markdown 差不多已经成为技术文档的标准.它可以实现技术文档的快捷写作,以及输出发布.同样都是标记语言,但Mark ...
- 写论文时,Word文档修改保存后,文件越来越大的解决方法
写论文时,Word文档经过反复修改保存后,文件会越来越大,十分烦人,网上找了很多解决办法,按个尝试,现在总结分享出来,让大家少走弯路. 缩小word文件大小第一招: Word在保存DOC文件时只是把一 ...
- 软件测试用例编写规范文档,模板都给你了我看谁还不会写测试用例
目录 前言 一 概述 1.1目的 1.2使用范围 二 测试用例编写原则 2.1系统性 2.2连贯性 2.3全面性 三 测试用例设计方法 3.1 等价类划分法: 3.2 边界值分析法: 3.3 因果图法 ...
最新文章
- Nature Genetics:微生物如何适应植物的?
- 算法的时间和空间复杂度
- ASP.Net生成静态HTML页!
- 本地kubectl客户端连接远程K8S集群
- 【每日一题】4月8日题目精讲 黑白树
- 【转载】6种.net分布式缓存解决方案
- java.lang.object源码_第三篇:java.lang.Object 类源码分析
- lesson 4 communication pattern
- 集合源码(一)之hashMap、ArrayList
- mysql 数据库自动备份(bat+计划任务方式)--亲测备份及还原成功
- pycharm 代码跳转
- 《大数据工程师 面经 自己整理 面试题1--》
- 程序员最爱的11个在线社区,你去过几个?
- MFC弹出确认和取消对话框
- python3 logging输出到文件_python3:logging模块 输出日志到文件
- 百度之星资格赛1003 度度熊与邪恶大魔王
- 纯干货!短视频脚本怎么写?零基础新手小白也能写好短视频脚本!【覃小龙课堂】
- cad考试题库绘图题答案_最新CAD考试题库及答案-cad考试题库绘图题答案
- 网页设计各种颜色搭配 并且哪几种颜色可以做成哪种风格
- 光和储能结合模型(Matlab代码实现)