怎么写设计文档–概要设计求解答（如何写设计文档——大纲设计解答文章)

在需求分析进行完成之后 项目进入设计阶段。在设计阶段需要编写设计文档。开发过程中的设计文档 分为： 概要设计和详细设计 2个部分。概要设计是将杂系统按功能进行 模块划分、建立层次结构及调用关系、包括数据特征描述 ,以及界面等。概要设计 是由架构师和每个开发者共同完成的，主要阅读者是客户和测试人员，其次是开发者和架构师。 详细设计 是由每个开发者根据 概要设计 文档共同完成的，主要阅读者是开发者们，其次是架构师和测试人员，再次是客户。 对于任何设计文档，需要项目小组内每个成员的参与编写，另外，需要交叉式的相互评审，还需要有评审结果，成员根据评审结果进行修改，将修改过的文档打给客户，等待客户的评审。

如果客户有意见或者建议，将继续修改，修改完成，继续小组评审，依次循环的工作，直到双方不再提出任何的疑问，才能进入下一个阶段，如果概要设计完成，将进入详细设计，如果详细设计完成，才能进入正式编码阶段。

–end–在大多数软件项目中，要末不作详细设计，要么开发完成后再补详细设计文档，质量也不容乐观，文档与系统往往不能同步，使详细设计文档完全流于形式，对工作没有起到实际的帮助。

详细设计是相对概要设计而言的，是瀑布开发流程的一个重要环节，在概要设计的高层设计的基础上，从逻辑上实现了每一模块的功能，是编码阶段的主要参考资料，是从高层到低层、逐步精化思想的具体实现。

详细设计文档的内容包括各个模块的算法设计，

接口设计，

数据结构设计，交互设计等。必须写清楚各个模块/接口/公共对象的定义，列明各个模块程序的

各种执行条件与期望的运行效果，还要正确处理各种可能的异常。

在开发过程中，由需求及设计不正确、不完整所导致的问题是项目进度拖延、失败的一个主要因素，而软件系统的一个重要特性就是需求和设计的不断构建和改进，在写详细设计文档过程中，

详细设计实际上是对系统的一次逻辑构建，可以有效验证需求的完整性及正确性。

如果不写详细设计文档，一般就从概设直接进入编码阶段，这时开发人员所能参考的资料就是需求规格说明书及页面原型、数据库设计等，不能直接进行开发，需要进行信息的沟通，把页面原型不能体现的设计讲清楚，这样既容易遗忘，也容易发生问题，详细设计文档可以作为需求人员、总体设计人员与开发人员的沟通工具，把静态页面无法体现的设计体现出来，包含整体设计对模块设计的规范，体现对设计上的一些决策，例如选用的算法，对一些关键问题的设计考虑等等，使开发人员能快速进入开发，提高沟通效率，减少沟通问题。

对于系统功能的调整，后期的维护，详设文档提供了模块设计上的考虑、决策，包括模块与整体设计的关系、模块所引用的数据库设计、重要操作的处理流程、重要的业务规则实现设计等等信息，提供了对模块设计的概述性信息，阐明了模块设计上的决策，配合代码注释，可以相对轻松读懂原有设计。

·存在的问题要由专门的人写，是比较麻烦的，也是很需要时间的，会对进度造成压力，也容易形成工作瓶颈，使设计人员负担过重，而开发人员无事可作。对于现在一般的以数据库为中心的管理系统而言，这个工作始终是要作的，区别只不过是不是形成专门文档，形成文档可能会多花一两周时间，但相对于规避的风险和问题来说，也是值得的，另外由于现在高级语言的流行，所以更详细的设计应该直接体现在代码的设计上，而文档则只体现设计上的一些决策，协调整体设计与模块设计的关系，把页面原型所不能体现的设计情况文档化，所以所花费的时间是有限的。

设计内容容易过细，但设计阶段是不能考虑特别清楚地，时间也不允许。

对于这个问题，一个对策是上边所提到的，文档只体现设计上的决策，页面原型所不能反映的信息，详细设计只体现总体设计对模块设计的一些考虑，例如对功能的数据库设计等等，而具体的实现实现，则到代码中再去实现，相关的设计也仅体现在代码中。

需求、设计需要不断的被更新、构建，则设计文档需要不断的重新调整，文档的维护需要跟上，否则文档和系统的同步就很难得到保障了，且造成多余的工作量。文档的内容易流于形势，质量糟糕，不能成为开发人员的参考手册，一是要建立起相关制度，如有修改，先改文档，后作开发，从工作流程上切实保障文档与系统的同步，二是要规范文档质量，对文档该写什么，不该写什么，标准是什么，粒度是什么，语法应该如何组织，有明确的标准和考虑，同时，建立审计文档评审、审核制度，充分保障系统的使用。·

首先是文档的内容，根据项目和团队的不同，详细设计文档的内容也有所不同，一般说来，粒度不宜过细，不能代替开发人员的设计和思考，但要把有关设计的决策考虑进去，包括与其他模块、整体设计的关系、操作的处理流程，对业务规则的设计考虑等，有一个标准为，凡是页面原型、需求规格说明书所不能反映的设计决策，而开发人员又需要了解的，都要写入文档。

其次是文档所面向的读者，主要为模块开发人员、后期维护人员，模块开发人员通过详细设计文档和页面原型来了解所开发的功能，后期维护人员通过实际系统、模块代码、详细设计文档来了解一个功能。

再有就是谁来写文档，因为文档主要考虑的是设计上的决策，所以写文档的人应该为负责、参加设计的技术经理、资深程序员，根据团队情况和项目规模、复杂度的不同，也有所不同。

还需要保证文档的可读性、准确性、一致性，要建立严格的文档模板及标准，保证文档的可读性及准确性，同时建立审核及设计评审制度，来保障设计及文档的质量，另外在工作流程中要强调，要先设计、先写文档，再进行开发。

现行住宅设计标准文件

不同性质的住宅这方面的标准和规格也不一样，如果你要做的是智能或者生态型住宅，那墙面材料、保温性能、采暖等要求和传统的住宅是不一样的。

这是一些住宅标准，你可以参考一下。

标准号名称施行日期

05SJ917-1 小城镇住宅通用（示范）设计--北京地区 2009-01-01

05SJ917-2 小城镇住宅通用（示范）设计--辽宁抚顺地区 2009-01-01

05SJ917-3 小城镇住宅通用（示范）设计--青海西宁地区 2009-01-01

05SJ917-4 小城镇住宅通用（示范）设计--陕西西安地区 2009-01-01

05SJ917-5 小城镇住宅通用（示范）设计--浙江绍兴地区 2009-01-01

05SJ917-6 小城镇住宅通用（示范）设计--福建福州地区 2009-01-01

05SJ917-7 小城镇住宅通用（示范）设计--广东东莞地区 2009-01-01

05SJ917-8 小城镇住宅通用（示范）设计--重庆地区 2009-01-01

05SJ917-9 小城镇住宅通用（示范）设计--广西南宁地区 2009-01-01

05SJ918-1 传统特色小城镇住宅--徽州地区 2009-09-01

05SJ918-2 传统特色小城镇住宅--泉州地区 2009-01-01

05SJ918-3 传统特色小城镇住宅--丽江地区 2009-01-01

05SJ918-5 传统特色小城镇住宅--新疆、吐鲁番、和田地区 2009-01-01

05SJ918-6 传统特色小城镇住宅--东北地区 2009-01-01

05SJ918-7 传统特色小城镇住宅--北京地区 2009-01-01

05SJ918-8 传统特色小城镇住宅--浙江嘉兴、台州地区 2009-01-01

05SJ919 小城镇住宅建筑构造

05SK510 小城镇住宅采暖通风设备选用与安装

CECS 173-2004 水泥聚苯模壳格构式混凝土墙体住宅技术规程(附条文说明) 2005-02-01

CECS 179-2005 健康住宅建设技术规程(附条文说明) 2005-06-01

DB63/ 768-2009 集中供暖住宅分户热计量设计与施工技术规程 2009-03-01

DGJ 08-20-2007 住宅设计标准(附条文说明)

DGJ 08-2015-2007 郊区中心村住宅设计标准(附条文说明)

DG/TJ 08-2029-2007 多高层钢结构住宅技术规程(附条文说明)

DGJ32/J 26-2006 江苏省住宅设计标准(附条文说明)

GB/T 22633-2008 住宅部品术语 2009-10-01

GB 50327-2001 住宅装饰装修工程施工规范 2005-05-01

GB/T 50355-2005 住宅建筑室内振动限值及其测量方法标准(附条文说明) 2005-10-01

GB/T 50362-2005 住宅性能评定技术标准 2006-03-01

GB 50368-2005 住宅建筑规范

《标准信息库bzxxk》一般抹灰工程

4.2.1本节适用于石灰砂浆、水泥砂浆、水泥混合砂浆、聚合物水泥砂浆和麻刀石灰、纸筋石灰、石膏灰等一般抹灰工程的质量验收。一般抹灰工程分为普通抹灰和高级抹灰，当设计无要求时，按普通抹灰验收。

4.2.1本规范将原标准中一般抹灰工程分为普通抹灰、中级抹灰和高级抹灰三级合并为普通抹灰和高级抹灰两级，主要是由于普通抹灰和中级抹灰的主要工序和表面质量基本相同，将原中级抹灰的主要工序和表面质量作为普通抹灰的要求。抹灰等级应由设计单位按照国家有关规定，根据技术、经济条件和装饰美观的需要来确定，并在施工图中注明。

________________________________________

4.2.2抹灰前基层表面的尘土、污垢、油渍等应清除干净，并应洒水润湿。

检验方法：检查施工记录。

4.2.3一般抹灰所用材料的品种和性能应符合设计要求。水泥的凝结时间和安定性复验应合格。砂浆的配合比应符合设计要求。

检验方法：检查产品合格证书、进场验收记录、复验报告和施工记录。

4.2.3材料质量是保证抹灰工程质量的基础，因此，抹灰工程所用材料如水泥、砂、石灰膏、石膏、有机聚合物等应符合设计要求及国家现行产品标准的规定，并应有出厂合格证；材料进场时应进行现场验收，不合格的材料不得用在抹灰工程上，对影响抹灰工程质量与安全的主要材料的某些性能如水泥的凝结时间和安定性进行现场抽样复验。

4.2.4抹灰工程应分层进行。当抹灰总厚度大于或等于35 mm时，应采取加强措施。不同材料基体交接处表面的抹灰，应采取防止开裂的加强措施，当采用加强网时，加强网与各基体的搭接宽度不应小于100 mm。

检验方法：检查隐蔽工程验收记录和施工记录。

4.2.4抹灰厚度过大时，容易产生起鼓、脱落等质量问题；不同材料基体交接处，由于吸水和收缩性不一致，接缝处表面的抹灰层容易开裂，上述情况均应采取加强措施，以切实保证抹灰工程的质量。

4.2.5抹灰层与基层之间及各抹灰层之间必须粘结牢固，抹灰层应无脱层、空鼓，面层应无爆灰和裂缝。

检验方法：观察；用小锤轻击检查；检查施工记录。

4.2.5抹灰工程的质量关键是粘结牢固，无开裂、空鼓与脱落如果粘结不牢，出现空鼓、开裂、脱落等缺陷，会降低对墙体保护作用，且影响装饰效果。经调研分析，抹灰层之所以出现开裂、空鼓和脱落等质量问题，主要原因是基体表面清理不干净，如：基体表面尘埃及疏松物、脱模剂和油渍等影响抹灰粘结牢固的物质未彻底清除干净；基体表面光滑，抹灰前未作毛化处理；抹灰前基体表面浇水不透，抹灰后砂浆中的水分很快被基体吸收，使砂浆质量不好，使用不当；一次抹灰过厚，干缩率较大等，都会影响抹灰层与基体的粘结牢固。

________________________________________

4.2.6一般抹灰工程的表面质量应符合下列规定：

1普通抹灰表面应光滑、洁净、接槎平整，分格缝应清晰。

2高级抹灰表面应光滑、洁净、颜色均匀、无抹纹，分格缝和灰线应清晰美观。

检验方法：观察；手摸检查。

4.2.7护角、孔洞、槽、盒周围的抹灰表面应整齐、光滑；管道后面的抹灰表面应平整。

检验方法：观察。

4.2.8抹灰层的总厚度应符合设计要求；水泥砂浆不得抹在石灰砂浆层上；罩面石膏灰不得抹在水泥砂浆层上。

检验方法：检查施工记录。

4.2.9抹灰分格缝的设置应符合设计要求，宽度和深度应均匀，表面应光滑，棱角应整齐。

检验方法：观察；尺量检查。

4.2.10有排水要求的部位应做滴水线（槽）。滴水线（槽）应整齐顺直，滴水线应内高外低，滴水槽宽度和深度均不应小于10 mm。

检验方法：观察；尺量检查。

4.2.11一般抹灰工程质量的允许偏差和检验方法应符合表4.2.11的规定。

表4.2.11一般抹灰的允许偏差和检验方法

项次 项目 允许偏差 检验方法

普通抹灰 高级抹灰

1 立面垂直度 4 3 用2 m垂直检测尺检查

2 表面平整度 4 3 用2 m靠尺和塞尺检查

3 阴阳角方正 4 3 用直角检测尺检查

4 分格条（缝）直线度 4 3 用5 m线，不足5 m拉通线，用钢直尺检查

5 墙裙、勒脚上口直线度 4 3 拉5 m线，不足5 m拉通线，用钢直尺检查

注：1）普通抹灰，本表第3项阴角方正可不检查；

2）顶棚抹灰，本表第2项表面平整度可不检查，但应平顺。

________________________________________

4.3 装饰抹灰工程

4.3.1本节适用于水刷石、斩假石、干粘石、假面砖等装饰抹灰工程的质量验收。

4.3.1根据国内装饰抹灰的实际情况，本规范保留了《建筑装饰工程施工及验收规范》（jgj73—91）中水刷石、斩假石、干粘石、假面砖等项目，删除了水磨石、拉条灰、拉毛灰、洒毛灰、喷砂、喷涂、滚涂、弹涂、仿石和彩色抹灰等项目。但水刷石浪费水资源，并对环境有污染，应尽量减少使用。

________________________________________

4.3.2抹灰前基层表面的尘土、污垢、油渍等应清除干净，并应洒水润湿。

检验方法：检查施工记录。

4.3.3装饰抹灰工程所用材料的品种和性能应符合设计要求。水泥的凝结时间和安定性复验应合格。砂浆的配合比应符合设计要求。

检验方法：检查产品合格证书、进场验收记录、复验报告和施工记录。

4.3.4抹灰工程应分层进行。当抹灰总厚度大于或等于35 mm时，应采取加强措施。不同材料基体交接处表面的抹灰，应采取防止开裂的加强措施，当采用加强网时，加强网与各基体的搭接宽度不应小于100 mm。

检验方法：检查隐蔽工程验收记录和施工记录。

4.3.5各抹灰层之间及抹灰层与基体之间必须粘接牢固，抹灰层应无脱层、空鼓和裂缝。

检验方法：观察；用小锤轻击检查；检查施工记录。

________________________________________

4.3.6装饰抹灰工程的表面质量应符合下列规定：

1水刷石表面应石粒清晰、分布均匀、紧密平整、色泽一致，应无掉粒和接槎痕迹。

2斩假石表面剁纹应均匀顺直、深浅一致，应无漏剁处；阳角处应横剁并留出宽窄一致的不剁边条，棱角应无损坏。

3干粘石表面应色泽一致、不露浆、不漏粘，石粒应粘结牢固、分布均匀，阳角处应无明显黑边。

4假面砖表面应平整、沟纹清晰、留缝整齐、色泽一致，应无掉角、脱皮、起砂等缺陷。

检验方法：观察；手摸检查。

4.3.7装饰抹灰分格条（缝）的设置应符合设计要求，宽度和深度应均匀，表面应平整光滑，棱角应整齐。

检验方法：观察。

4.3.8有排水要求的部位应做滴水线（槽）。滴水线（槽）应政治课顺直，滴水线应内高外低，滴水槽的宽度和深度均不应小于10应采取加强措施。不同材料基体交接处表面的抹灰，应采取防止开裂的加强措施，当采用加强网时，加强网与各基体的搭接宽度不应小于100 mm。

检验方法：观察；尺量检查。

4.3.9装饰抹灰工程质量的允许偏差和检验方法应符合表4.3.9的规定。

表4.3.9装饰抹灰的允许偏差和检验方法

项次 项目 允许偏差（mm） 检验方法

水刷石 斩假石 干粘石 假面砖

1 立面垂直度 5 4 5 5 用2m靠尺和塞尺检查

2 表面平整度 3 3 5 4 用2m靠尺和塞尺检查

3 阳角方正 3 3 4 4 用直角检测尺检查

4 分格条（缝）直线度 3 3 3 3 用5m线，不足5m拉通线，用钢直尺检查

5 墙裙、勒脚上口直线度 3 3 — — 用5m线，不足5m拉通线，用钢直尺检查

参考资料： 《建筑装饰装修工程质量验收规范》gb50210—2013