详细设计怎么写

1. 如何写详细设计文档

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

·

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

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

接口设计,

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

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

·

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

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

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

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

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

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

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

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

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

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

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

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

2. 概要设计和详细设计怎么写 知乎

撰写的设计文档主要分为:总体概要设计文档 + 详细设计文档,后简称为“概设”+“详设”。

总设和详设都应该包含的部分:

(1) 需求:一般以产品的语言描述,这一块可以拷贝产品需求文档中的story list部分;

(2) 名词解释(可选):非相关领域内的同学需要看到文档需要提前了解的一些概念性质的东西;

(3) 设计目标:又分为功能目标和性能目标,功能目标一般是对产品需求的技术描述,性能目标是根据产品给出的数据对性能进行的评估。一般来说,新服务必须要有性能目标一项,性能目标可能会影响设计方案。

除了都应该包含的部分,总体概要设计一般还包含:

(1) 系统架构:一般来说会有个简单的架构图,并配以文字对架构进行简要说明;

(2) 模块简介:架构图中如果有很多模块,需要对各个模块的功能进行简要介绍;

(3) 设计与折衷:设计与折衷是总体概要设计中最重要的部分;

(4) 潜在风险(可选);

输出总体概要设计的时候,很多方案还是不确定的,需要在设计评审会议上确认。

总体概要设计重点在“方案折衷”,总体概要设计评审完毕之后,此时应该是所有方案都确认了,需要输出各模块的详细设计,详细设计重点在“详细”:

(1)总体概要设计结论汇总(可选):达成一致的结论有个简要概述,说明详设是对这些结论的实现;

(2)交互流程:简要的交互可用文字说明,复杂的交互建议使用流程图,交互图或其他图形进行说明;

(3)数据库设计:这个是应该放在总设还是详设呢?

(4)接口形式:有了数据库+接口+流程,别的同学拿到详设文档,基本也能够搞定了;

(5)其他细节:例如公式等;

理论上输出了详细设计之后,无论谁拿到了这个详设文档,都是能够完成该项目的。

个人实践分享:

一、大图

(1) 大系统或复杂流程,其架构图或者流程图会非常大,经常比A4纸或word的一页大很多,此时不宜在word中直接贴图形,贴了也看不清,建议将图放在wiki上,文档中直接贴链接;

(2) 一定要保存viso或者其他图形的源文件,否则今后改动起来要重画,代价可想而知;

二、设计与折衷

(1) 设计与折衷是总设中最重要的内容,总设评审中,主要就是讨论这些折衷的优劣;

(2) 评审过后,不但要邮件周知结论,还要在总设中进行更新,说明最终决定使用了哪种方案,为什么使用这种方案;根据自己的经验,接手别人的模块、项目,拿到代码和文档,设计方案对我来说完全是个谜!!!

(3) 有时候因为排期或者其他原因,不一定采用了最优的设计方案,此时更应该在总设中记录决策的过程与原因;

(4) 最后,设计折衷是一个很好的自我辩解的机会:因为项目进度,或者历史遗留问题,我不得不采取了一个这样的设计,不要再骂我了。

三、性能目标

性能目标是新模块文档必不可少的一部分,很多项目对性能影响较大的话,也必须撰写性能目标,性能一般来说可能包含以下部分:

(1) 日平均请求:一般来自产品人员的评估;

(2) 平均QPS:日平均请求 除以 4w秒得出,为什么是4w秒呢,24小时化为86400秒,取用户活跃时间为白天算,除2得4w秒;

(3) 峰值QPS:一般可以以QPS的2~4倍计算;

互联网公司,产品迭代块,项目周期长,基本没有“文档”一说,但其实写好文档,对系统和项目未来的维护是非常有帮助的。

3. 详细设计说明书到底怎么写

原发布者:fxort04

LyraResourcePlatform文档详细设计说明书详细设计说明书1.引言1.1编写目的本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计,在概要设计的基础上进一步明确系统结构,详细地介绍系统的各个模块,为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣,在以后想对系统进行扩展和维护的人员。2.系统的结构ui:系统界面部分,负责接受用户输入,显示系统输出,负责其他模块功能的协调调用,并含有站内搜索功能,即在用户指定的已打开的ftp站点中搜索用户需要的资源。ui部分调用common部分的功能读取xml文件中保存的界面元素属性信息,用户最近访问过的10个ftp信息,用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。client:实现ftp客户端的功能,ftp连接,ftp上传及下载:上传或下载用户指定的1LyraResourcePlatform文档详细设计说明书资源,并返回相应的信息。search:资源实时检索部分,根据用户输入的资源名称关键字,资源类型和选择的检索方式检索用户需要的资源,并验证资源的可用性,返回可用资源及其大小,速度等相关信息。preview:资源预览部分,显示用户选择的资源的部分内容,以使用户决定是否需要该资源。preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。3.模块

4. 如何写详细设计文档

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

·详细设计是相对概要设计而言的,是瀑布开发流程的一个重要环节,在概要设计的高层设计的基础上,从逻辑上实现了每一模块的功能,是编码阶段的主要参考资料,是从高层到低层、逐步精化思想的具体实现。详细设计文档的内容包括各个模块的算法设计,接口设计,数据结构设计,交互设计等。

必须写清楚各个模块/接口/公共对象的定义,列明各个模块程序的各种执行条件与期望的运行效果,还要正确处理各种可能的异常。·在开发过程中,由需求及设计不正确、不完整所导致的问题是项目进度拖延、失败的一个主要因素,而软件系统的一个重要特性就是需求和设计的不断构建和改进,在写详细设计文档过程中,详细设计实际上是对系统的一次逻辑构建,可以有效验证需求的完整性及正确性。

如果不写详细设计文档,一般就从概设直接进入编码阶段,这时开发人员所能参考的资料就是需求规格说明书及页面原型、数据库设计等,不能直接进行开发,需要进行信息的沟通,把页面原型不能体现的设计讲清楚,这样既容易遗忘,也容易发生问题,详细设计文档可以作为需求人员、总体设计人员与开发人员的沟通工具,把静态页面无法体现的设计体现出来,包含整体设计对模块设计的规范,体现对设计上的一些决策,例如选用的算法,对一些关键问题的设计考虑等等,使开发人员能快速进入开发,提高沟通效率,减少沟通问题。对于系统功能的调整,后期的维护,详设文档提供了模块设计上的考虑、决策,包括模块与整体设计的关系、模块所引用的数据库设计、重要操作的处理流程、重要的业务规则实现设计等等信息,提供了对模块设计的概述性信息,阐明了模块设计上的决策,配合代码注释,可以相对轻松读懂原有设计。

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

设计内容容易过细,但设计阶段是不能考虑特别清楚地,时间也不允许。对于这个问题,一个对策是上边所提到的,文档只体现设计上的决策,页面原型所不能反映的信息,详细设计只体现总体设计对模块设计的一些考虑,例如对功能的数据库设计等等,而具体的实现实现,则到代码中再去实现,相关的设计也仅体现在代码中。

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

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

再有就是谁来写文档,因为文档主要考虑的是设计上的决策,所以写文档的人应该为负责、参加设计的技术经理、资深程序员,根据团队情况和项目规模、复杂度的不同,也有所不同。还需要保证文档的可读性、准确性、一致性,要建立严格的文档模板及标准,保证文档的可读性及准确性,同时建立审核及设计评审制度,来保障设计及文档的质量,另外在工作流程中要强调,要先设计、先写文档,再进行开发。

转载请注明出处育才学习网 » 详细设计怎么写

知识

生育保险委托书怎么写

阅读(196)

本文主要为您介绍生育保险委托书怎么写,内容包括生育保险报销委托书怎么写,生育保险委托书怎么写,请问代领生育保险委托书怎么写。生育保险委托书范本社会保险管理中心:本人XX,因不能亲自前往贵中心办理生育保险待遇的申领手续,特委托XXX身份

知识

流的繁体字怎么写

阅读(177)

本文主要为您介绍流的繁体字怎么写,内容包括流繁体字怎么写,“流”的繁体字怎么写,流字的繁体字怎么写。流字的繁体字

知识

飞字的繁体字怎么写

阅读(208)

本文主要为您介绍飞字的繁体字怎么写,内容包括飞字繁体怎么写,[飞]字的繁体字怎么写啊,“飞”的繁体字怎么写。“飞”的繁体字如图

知识

人生观怎么写

阅读(181)

本文主要为您介绍人生观怎么写,内容包括怎样写个人的的人生观天涯问答天涯社区,人生观怎么写,人生观怎么写。要正确对待恋爱。 正确处理好恋爱、学业、事业三者之间的关系。恋爱是人生的一件大事,但并不是人生的全部。大学生应该以学业为重,

知识

应用价值怎么写

阅读(285)

本文主要为您介绍应用价值怎么写,内容包括有谁知道技术推广应用价值怎么写,一,本课题研究的理论和实际应用价值怎么写,形容应用价值的词语。学术价值,主要看它的理论价值,即对于现有理论的贡献,或验证现有的理论、或充实现有的理论;如果没有大

知识

课程感想怎么写

阅读(222)

本文主要为您介绍课程感想怎么写,内容包括。问题 学习后的感想和收获该怎么写?主回答学习中最基本的一点,就是要主动。学习是自己的事,只有积极主动地学习方能感受到学习的乐趣,方能学有

知识

画家简介怎么写

阅读(244)

本文主要为您介绍画家简介怎么写,内容包括画家的简历怎么写,画画简介怎么写,给一个画家的简介。姓名:几米(1958年11月15日- ),原名 廖福彬 ,生于台湾宜兰,是台湾著名绘本画家。他的笔名来自其英文名 Jimmy 。性别:

知识

箫字怎么写

阅读(156)

本文主要为您介绍箫字怎么写,内容包括箫字怎么打,箫繁体怎么写,萧字繁体字怎么写。箫 tvi 或 tvijt(竹字头)v(彐)i(小)j(两竖)“授人以鱼,不如授人以渔”用五笔输入法常常会碰到一些一时打不出来的字,如果

知识

党员自传怎么写

阅读(157)

本文主要为您介绍党员自传怎么写,内容包括入党个人自传怎么写,入党的自传怎么写谢谢急用,党员自传怎么写。我叫,系**大学**专业学生,男,*族,1982年11月26日出生于**省**市的一个知识分子家庭。就在这样一个普通而又温暖的家庭,我健

知识

后悔书怎么写

阅读(177)

本文主要为您介绍后悔书怎么写,内容包括后悔书怎么写,抢劫后悔书怎么写,开庭程序后悔书怎么写。领导:对不起,我错了!首先表示道歉!因为我意识的冲动,不想后果的写了退学申请,以为自己可以从此离开学校,不再回头。可适当冷静下来之后,不

知识

活动英文怎么写

阅读(173)

本文主要为您介绍活动英文怎么写,内容包括活动用英语怎么说怎么读音,"活动”英文怎么写,活动、用英语怎么写。activity双语例句1.每个人都愿意参加这一活动。Everybody likes to join in this activity.

知识

飞字行书怎么写

阅读(199)

本文主要为您介绍飞字行书怎么写,内容包括飞字行书怎样写,怎么写飞字的行书,飞”字的钢笔字行书写法怎么写。

知识

我想对你说作文怎么写

阅读(162)

本文主要为您介绍我想对你说作文怎么写,内容包括某某某我想对你说作文怎么写,妈妈我想对你说作文怎么写,《我想对你说》这篇作文怎么写。《妈妈我想对你说》每次唱到“世上只有妈妈好”这首歌时,我就会想我和蔼可亲的妈妈。我的妈妈是一位平

知识

池塘怎么写

阅读(188)

本文主要为您介绍池塘怎么写,内容包括关于池塘的作文怎么写,我家的池塘作文怎么写,描写春天的优美句子有池塘丶怎样写。篇一:夏天的池塘我的家乡在广州,那里的空气清新甜润,是一个美丽的地方。我居住的小区里,有一个风景如画的小池塘。夏天,水面

知识

论文设计要求怎么写

阅读(176)

本文主要为您介绍论文设计要求怎么写,内容包括毕业设计基本要求怎么写,毕业论文设计怎么写,毕业论文的格式是什么要求多少字。毕业设计的基本要求1.按任务书的规定,学生在教师的指导下,独立完成所要求的内容,严禁抄袭;2.设计方案合理、可行,图面

知识

毕业设计摘要怎么写

阅读(170)

本文主要为您介绍毕业设计摘要怎么写,内容包括毕业设计摘要如何写,毕业设计的摘要怎么写,怎么写毕业设计摘要。摘要是毕业设计(论文)的内容不加注释和评论的简短陈述。摘要主要是说明研究工作的目的、方法、结果和结论。摘要应具有独立性和自

知识

设计师个人简介怎么写

阅读(224)

本文主要为您介绍设计师个人简介怎么写,内容包括优秀的平面设计师自我介绍怎么写,设计师个人简介怎么写,设计个人简历中的自我介绍怎么写。平面设计师面试自我介绍(一) 我叫XXX,是***大学平面设计专业的学生,我热爱我的专业,因为学设计可以绘画

知识

设计摘要怎么写

阅读(235)

本文主要为您介绍设计摘要怎么写,内容包括毕业设计的摘要怎么写,毕业设计摘要如何写,怎么写毕业设计摘要。你好! 请参考: 毕业论文摘要的书写方法和技巧 1. 摘要的作用 摘要也就是内容提要,是论文中不可缺少的一部分。论文摘要是一篇具

知识

设计思想怎么写

阅读(192)

本文主要为您介绍设计思想怎么写,内容包括创意说明,设计思想,怎么写,书籍装帧设计说明怎么写啊,请问下如何写设计思想和创意内容有范文的指教。1. 设计思想是指设计者在设计前及设计过程中的思维模式及逻辑模式。2. 设计者在设计前及设计过

知识

实验设计怎么写

阅读(164)

本文主要为您介绍实验设计怎么写,内容包括实验设计方案怎么写,实验设计怎么写,实验设计方案怎么写。一种有计划的研究,包括一系列有意图性的对过程要素进行改变与其效果观测,对这些结果进行统计分析以便确定过程变异之间的关系,从而改变这过程

知识

施工组织设计怎么写

阅读(155)

本文主要为您介绍施工组织设计怎么写,内容包括施工组织计划怎么写,施工组织设计怎么写,施工组织设计怎么写。原发布者:bdwk123110施工方案怎么写以下内容是某企业对建筑施工方案编制的要求,供参考。施工组织设计(方案)的主要章节内容要求如下

知识

课题设计怎么写

阅读(179)

本文主要为您介绍课题设计怎么写,内容包括课题研究计划怎么写,研究设计怎么写,论文开题报告中的课题设计方案怎么写。课题研究计划(或称开题报告)是有格式要求的.一般包括:课题名称、选题背景、理由、国内外成果综述、研究内容、目标、方法、

[/e:loop]