详细设计文档_详细设计文档评审 - CSDN
精华内容
参与话题
  • 华为详细设计文档,很规范,可以作为模版使用。。
  • 软件详细设计文档

    千次下载 热门讨论 2020-07-28 11:13:44
    软件设计详细说明,开发流程等
  • 软件详细设计文档模板

    万次阅读 2014-07-11 17:38:18
    给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是否子程序?是可重人的还是不可重人的?有无覆盖要求?是顺序处理还是并发处理等)。 1.2...

    1.1程序描述
    给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是否子程序?是可重人的还是不可重人的?有无覆盖要求?是顺序处理还是并发处理等)。
    1.2功能
    说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。
    1.3性能
    说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。
    1.4输人项
    给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
    1.5输出项
    给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。
    1.6算法
    详细说明本程序所选用的算法,具体的计算公式和计算步骤。
    1.7流程逻辑
    用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。
    1.8接口
    用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构(数据库、数据文卷)。
    1.9存储分配
    根据需要,说明本程序的存储分配。
    1.10注释设计
    说明准备在本程序中安排的注释,如:
    a. 加在模块首部的注释;
    b. 加在各分枝点处的注释;
    c. 对各变量的功能、范围、缺省条件等所加的注释;
    d. 对使用的逻辑所加的注释等等。
    1.11限制条件
    说明本程序运行中所受到的限制条件。
    1.12测试计划
    说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
    1.13尚未解决的问题
    说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
    4程序2(标识符)设计说明
    用类似F.3的方式,说明第2个程序乃至第N个程序的设计考虑。

    转载地址:http://bbs.csdn.net/topics/60465453

    展开全文
  • 如何写详细设计文档

    万次阅读 2014-03-27 14:08:44
    如何写详细设计文档是一个很头疼的话题,简单的说是需求文档的升华,也可以说是开发人员开发程序的依据,当然根据详细设计文档的粒度进行。好的详细设计文档是需求人员和开发人员之间的桥梁,不过目前好多程序开发都...

    如何写详细设计文档是一个很头疼的话题,简单的说是需求文档的升华,也可以说是开发人员开发程序的依据,当然根据详细设计文档的粒度进行。好的详细设计文档是需求人员和开发人员之间的桥梁,不过目前好多程序开发都是先开发后,然后为了应付审核,公司制度,文档规范,开发完成后后续补上该文档。如果这样的方式,详细设计文档的的作用就忽略了。

     

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

    那到底应不应该写详细设计文档呢,怎么使详细设计文档起到他应有的作用呢,下面就让我们来认识一下详细设计及写详细设计文档的好处和问题。

    ·            概念

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

    详细设计文档的内容包括各个模块的算法设计, 接口设计, 数据结构设计,交互设计等。必须写清楚各个模块/接口/公共对象的定义,列明各个模块程序的各种执行条件与期望的运行效果,还要正确处理各种可能的异常。

    ·       目的

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

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


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

    ·             问题

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

    设计内容容易过细,但设计阶段是不能考虑特别清楚地,时间也不允许。 
     
    对于这个问题,一个对策是上边所提到的,文档只体现设计上的决策,页面原型所不能反映的信息,详细设计只体现总体设计对模块设计的一些考虑,例如对功能的数据库设计等等,而具体的实现实现,则到代码中再去实现,相关的设计也仅体现在代码中。 
         
    需求、设计需要不断的被更新、构建,则设计文档需要不断的重新调整,文档的维护需要跟上,否则文档和系统的同步就很难得到保障了,且造成多余的工作量。文档的内容易流于形势,质量糟糕,不能成为开发人员的参考手册,一是要建立起相关制度,如有修改,先改文档,后作开发,从工作流程上切实保障文档与系统的同步,二是要规范文档质量,对文档该写什么,不该写什么,标准是什么,粒度是什么,语法应该如何组织,有明确的标准和考虑,同时,建立审计文档评审、审核制度,充分保障系统的使用。

     

    ·           步骤

    下面讨论如何写出一个符合要求、实用的详细设计文档。

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

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

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

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

    展开全文
  • 如何写详细设计文档

    万次阅读 2018-05-30 09:57:55
    在大多数软件项目中,要末不作详细设计,要么开发完成后再补详细设计文档,质量也不容乐观,文档与系统往往不能同步,使详细设计文档完全流于形式,对工作没有起到实际的帮助。那到底应不应该写详细设计文档呢,怎么...

      在大多数软件项目中,要末不作详细设计,要么开发完成后再补详细设计文档,质量也不容乐观,文档与系统往往不能同步,使详细设计文档完全流于形式,对工作没有起到实际的帮助。那到底应不应该写详细设计文档呢,怎么使详细设计文档起到他应有的作用呢,下面就让我们来认识一下详细设计及写详细设计文档的好处和问题。

    什么是详细设计

      详细设计是相对概要设计而言的,是瀑布开发流程的一个重要环节,在概要设计的高层设计的基础上,从逻辑上实现了每一模块的功能,是编码阶段的主要参考资料,是从高层到低层、逐步精化思想的具体实现。详细设计文档的内容包括各个模块的算法设计, 接口设计, 数据结构设计交互设计等。必须写清楚各个模块/接口/公共对象的定义,列明各个模块程序的各种执行条件与期望的运行效果,还要正确处理各种可能的异常。

    为什么要作详细设计

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

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

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

    存在的问题

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

    设计内容容易过细,但设计阶段是不能考虑特别清楚地,时间也不允许。 
      对于这个问题,一个对策是上边所提到的,文档只体现设计上的决策,页面原型所不能反映的信息,详细设计只体现总体设计对模块设计的一些考虑,例如对功能的数据库设计等等,而具体的实现,则到代码中再去实现,相关的设计也仅体现在代码中。 
      需求、设计需要不断的被更新、构建,则设计文档需要不断的重新调整,文档的维护需要跟上,否则文档和系统的同步就很难得到保障了,且造成多余的工作量。文档的内容易流于形势,质量糟糕,不能成为开发人员的参考手册,一是要建立起相关制度,如有修改,先改文档,后作开发,从工作流程上切实保障文档与系统的同步,二是要规范文档质量,对文档该写什么,不该写什么,标准是什么,粒度是什么,语法应该如何组织,有明确的标准和考虑,同时,建立审计文档评审、审核制度,充分保障系统的使用。

    应该如何写详细设计文档

      下面讨论如何写出一个符合要求、实用的详细设计文档。

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

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

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

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

    展开全文
  • 软件开发文档-详细设计文档

    万次阅读 2019-06-21 11:22:34
    帮助开发人员理解项目的业务逻辑术语描述执行标准与相关文档 编码标准,文件管理标准,版本管理标准项目概述 1.背景 2.现状项目目标编码规范系统功能概述 系统功能总图系统总体介绍系统模块设计 模块结构图,...

    引言

    引言也称前言、序言或概述经常作为科技论文的开端,提出文中要研究的问题,引导读者阅读和理解全文


    编写目的

    帮助开发人员理解项目的业务逻辑


    术语描述


    执行标准与相关文档

    编码标准,文件管理标准,版本管理标准


    项目概述

    1、背景
    2、现状

    项目目标

    最终要实现的目标

    编码规范

    前端规范,后台规范,数据库规范,中间件使用规范


    系统功能概述

    系统功能总图

    系统总体介绍

    描述下系统的总体情况

    系统模块设计

    模块结构图,模块汇总表,功能简述


    模块功能点

    【功能描述:说明该程序应具有的功能,功能结构图,原型界面,可采用IPO图(即输入一处理一输出图),类图,用例图等。】

    1、输入项

    【给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。】

    2、输出项

    【给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。】

    3、算法

    【详细说明本程序所选用的算法,具体的计算公式和计算步骤。】

    4、逻辑流程

    【用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。】

    5、接口

    【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构。】

    6、存储分配

    【根据需要,说明本程序的存储分配。】

    7、注释设计

    【说明准备在本程序中安排的注释,如:

    a. 加在模块首部的注释;

    b. 加在各分枝点处的注释;

    c. 对各变量的功能、范围、缺省条件等所加的注释;

    d. 对使用的逻辑所加的注释等等。】

    8、限制条件

    【说明本程序运行中所受到的限制条件】

    9、测试计划

    【说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定】

    展开全文
  • 详细设计文档

    2020-07-25 23:31:30
    公安详细设计文档,主要是公安行业应用于验收的文档模板。
  • 详细设计文档格式

    万次阅读 2018-01-10 10:30:05
    (对文档中出现新的或不常见的名词、概念或简略语给出定义和解释) 3、设计目标 3.1、实现的功能 (概要描述要实现的功能,列出要实现的功能点及子功能点,并对每一个功能点进行详细说明。功能点之间的层级和...
  • 详细设计文档3.0

    千次阅读 2019-06-20 19:45:02
    详细设计文档 1.引言 随着广大在校大学生生活水平的提高,在假期选择外出旅游的学生愈加增多,针对大学生群体的旅游APP就显得很有市场价值。 1.1编写目的 本节描述软件详细设计文档的目的是: 定义软件总体要求...
  • web项目详细设计文档

    热门讨论 2020-07-30 23:33:23
    让初学web开发人员快速上手项目详细设计文档编写!
  • 详细设计文档包含概要设计文档的全部内容(不是绝对),也就是详细设计文档,其实是在概要设计文档的基础上进一步填充内容而得到的。那为什么还要分概要设计和详细设计文档呢,以房子为例:开发商只开发毛坯房,那么...
  • 需求文档是根据用户需求转化而来的技术实现需求,需要针对用户提出的产品目标进行细分,总结出具体的每一个...而系统设计文档则是站在开发人员的角度来软件需要实现的功能、各个模块和其重要性、以及业务流程等。 ...
  • 项目详细设计开发文档

    千次阅读 2018-03-13 10:46:23
    2.总体设计…3 2.1需求概述…3 2.2软件结构…4 3.程序描述…5 3.1功能…5 3.2性能…6 3.3输入项目…6 3.4输出项目…6 3.5算法…6 3.6程序逻辑…7 3.7接口…10 3.7.1外部接口…10 3.7.2内部接口…10 ...
  • 程序员最痛苦的几件事:1.别人不写文档,2.别人不写注释,3.... 今天暂时不讨论为什么开发人员对文档有这么大的抵触情绪,这篇文章主要讨论如何解决最难搞定又往往最没用的软件过程文档——软件详细设计说明书。
  • javaweb项目设计文档

    万次阅读 2016-11-27 15:05:24
    项目需求、分析设计
  • Android APP 设计说明书模板

    万次阅读 2016-04-28 12:29:18
    因公司申请软件著作权需要,我临时转行成为文员,写设计说明书,测试报告什么的。分享一下我的设计说明书部分纲要,仅供参考。
  • 软件概要设计与详细设计的区别

    万次阅读 多人点赞 2012-03-22 14:34:01
    概要设计与详细设计的区别  概要设计就是设计软件的结构,包括组成模块,模块的层次结构,模块的调用关系,每个模块的功能等等。同时,还要设计该项目的应用系统的总体数据结构和数据库结构,即应用系统要存储什么...
  • 项目开发文档编写规范

    万次阅读 多人点赞 2018-05-13 17:50:38
    在开发项目的过程中,我深刻的意识到,文档存在的意义并不是无用的报告,简洁明了的文档不光能记录你当下所做的,还能在繁重的工作中分神思考下一步该做什么时为你节约精力,并且在项目周期内,使整个项目保持一致性...
  • 概要设计和详细设计的区别

    万次阅读 2015-12-24 13:40:50
    概要设计与详细设计的区别   概要设计就是设计软件的结构,包括组成模块,模块的层次结构,模块的调用关系,每个模块的功能等等。同时,还要设计该项目的应用系统的总体数据结构和数据库结构,即应用系统要存储...
  • 概要设计与详细设计的区别(转)

    万次阅读 2009-06-02 17:05:00
    概要设计与详细设计的区别 概要设计就是设计软件的结构,包括组成模块,模块的层次结构,模块的调用关系,每个模块的功能等等。同时,还要设计该项目的应用系统的总体数据结构和数据库结构,即应用系统要存储什么...
1 2 3 4 5 ... 20
收藏数 314,447
精华内容 125,778
关键字:

详细设计文档