详细设计说明书模板.docx

详细设计说明书模板.docx

《详细设计说明书模板.docx》由会员分享，可在线阅读，更多相关《详细设计说明书模板.docx（12页珍藏版）》请在冰豆网上搜索。

详细设计说明书模板

文档

文档呈送：

文档抄送：

XX工程

详细设计说明书

编写：

参与评审：

变更记录

版本号

变化状态

修改点说明

变更人

存放位置

审批人

审批日期

*变化状态：

C――创立，A——增加，M——修改，D——删除

修改点说明：

对变化状态进展简单解释，如增加了某项功能，修改了某个模块等信息。

不允许出现“根据评审意见修改等字样〞

注：

当文档未评审通过前版本号标识规那么为V0.X,第一次评审通过后，版本号直接升级为V1.0，之后变更按照V1.X升级。

1文档简介

[说明]

本局部要描述文档的目的，帮助读者对本文档建立根本印象，并为阅读后续内容扫清障。

蓝色字体局部是文档的说明，请各位同事在完成文档撰写后删除该局部。

编写目的

[说明]

本局部主要阐述文档目的，而非工程目的。

否那么造成同一工程多个文档之间的内容重复，不利于文档维护。

预期读者和阅读建议

[说明]

指定需要认真阅读此文档的人员。

本小节应指明文档针对的读者对象，最好列出各种读者角色，并说明每种读者角色应该重点阅读的章节。

指明文档组织方式，简要描述各文档各局部关注的内容和解决的问题。

定义、缩写词、略语

[说明]

按字母或拼音顺序列出所有的定义和缩略语，以便读者可以正确地理解?

架构设计说明书?

，包括词头和缩写。

注意：

只需要列出对理解本文有用的术语。

序号

术语/缩略语

说明/定义

英文全称

中文译名

1

2

3

...

参考资料

[说明]

列举编写?

架构设计说明书?

时所参考的资料或其它来源。

包括但不限于：

用户界面风格指导、合同、标准、系统需求规格说明书、用户需求、相关产品的产品需求规格说明书等。

可根据工程的实际情况选择参考资料的范围，但至少应包括用户需求说明书和需求分析说明书。

作者

文献名称

出版单位〔或归属单位〕

版本或日期

2前提和约束

前提条件

[说明]

对详细设计工作依赖的上游文档做说明。

可使用表格或文字进展简要说明，没有的工程写无。

类别

文件名称

主要依据章节及内容

是否完全依据

需求

是

架构

是

概要设计

是

其他前提条件

是

特殊情况说明：

限制和约束

[说明]

阐述应遵循的重要限制和约束，包括技术条件、软硬件条件、功能、性能目标约束等。

3综合描述

3.1系统目标

[说明]

系统最终要解决的实际问题或要到达的用户要求，系统如何能够做到客户满意。

3.2系统需求

[说明]

系统由上游文档规定的需求的简要说明。

说明本系统，本文档涵盖的需求及功能实现局部。

3.3系统概述

[说明]

简述系统功能，映射详细设计的根底轮廓。

用系统构造图表示系统内的包和主要类的名称、标识符和它们之间的层次构造关系，可以以系统体系构造划分，也可以由类类别划分（边界类、控制类、助手类、实体类、数据类），甚至可以由功能构造划分。

3.4程序构造说明

[说明]

结合上游文件中的逻辑视图，描述最终的程序划分、构造图及功能与调用关系简要说明、程序种类说明。

本节为以下详细设计的简要索引，为系统程序的上层构造体系描述。

详细设计时可能得不到准确的最终程序文件名列表，但是应当尽量完整说明其种类和主要文件内容。

建议使用UML图配合文字说明。

3.5源程序及编译组装说明

[说明]

结合上游文件中的物理视图，本处为源程序和前一节的最终程序如函数库、可执行程序、资源文件等的对照表，以及从源程序文件转化成这些最终文件的具体过程〔编译、、组装〕描述。

在详细设计时可能得不到准确的源程序文件名，但是应当尽量完整说明其种类和主要文件内容。

如果不同的文件具有不同的编译组装方式，那么应在此处分别描述清楚。

在此处应明确分出各级编译单元，即哪些文件需要一起编译生成一个或一组编译后的文件。

编译单元文件可以是最终文件也可以是源程序和最终文件之间的中间文件。

建议使用UML图配合文字说明。

4系统详细设计

[说明]

系统详细设计应当以3.4节程序构造说明节内容为索引，而不是3.5节源程序及编译组装说明，换句话说，应当以最终的物理功能实现〔逻辑视图〕为主线索，源程序的构造〔物理视图〕作为辅线索，结合数据构造〔数据视图〕进展存储设计，结合模块间交互〔运行视图〕。

编写原那么为公用的，重要的，接口类的程序段，应当尽量组织在文档前部，以示声明。

功能性的可以放在文档偏后的位置，如果使用公共模块应当标明引用章节位置。

建议在设计时做好公共模块的封装和组织。

如：

在说明公共函数所在的动态库时，如果动态库只有一个，而会被三个其他程序调用，应领先描述本动态库，说明动态库的详细设计，其他程序调用时说明引用地址，并列出源程序与函数的对照表。

如果遇到概要设计中没有写明的逻辑问题，那么应通知概要设计人员及时讨论并变更概要设计。

本章描述重点是程序段〔面向对象中称作类中的方法或在面向过程中称为函数〕。

在描述程序段过程中兼顾数据，流程，构造等内容。

菜单级别组织：

参考上游文档中五视图的划分，建议如下划分详细设计内容

对系统模块的划分可按以下两种方式进展：

方式一

按系统的层级进展分解，每个层机中分别描述模块的功能及交互数据等内容，如：

4.1系统第一层分解描述

4.1,1系统第二层分解

4.1.1.1系统第三层分解

4.1.1.1.1函数名称1

方式二

先划分子系统再划分包，再划分类，最后至方法：

4.1子系统

4.1.1包定义

4.1.1.1类定义

4.1.1.1.1方法名称1

以下以方式二为例说明：

菜单层级可以根据工程大小变化，方法或函数内的内容框架应当按照模板进展描述。

本处无文字。

4.1XXX子系统名称

[说明]

子系统描述，参考上游文件进展描述。

说明子系统的功能。

建议使用UML包图描述并附加说明。

需概括说明可以被其他系统调用接口，及需要调用其他接口情况。

如果较多可以使用列表说明。

4.1.1XXX包名称

[说明]

说明本包的功能，作用，划分依据，包内类的相互关系及其他包相关内容。

建议使用UML类图并并附加说明。

需概括说明可以被其他包调用接口，及需要调用其他包的情况。

如果较多可以使用列表说明。

4.1.1.1XXX类名称

[说明]

说明本类的功能，作用，划分依据，类内各个函数的相互关系及其他包相关内容。

需说明可以被其他类调用接口，及需要调用其他类的情况。

如果较多可以使用列表说明。

4.1.1.1.1XXXXX函数或方法名称1

a）方法特征描述

[说明]

<可在此描述其调用形式，如：

intGetNum（intiNum1,charcCha1）;>

b）功能性能描述

[说明]

<方法所完成的功能，如果有明确的性能指标分配，应当也在此注明。

该章节将作为单元测试的输入>

c）输入/输出项

[说明]

<如果是函数那么说明：

输入参数、输出参数、返回值，以及函数的处理对象在处理前和处理后的状态。

如果是其它形式的处理单元，那么描述相应的输入输出形式和内容。

如果输入输出需要某种条件触发，需明确描述输入输出项的发生条件。

异常抛出算做输出>

d）数据构造说明

[说明]

<公共变量，内存数据构造，存取的数据库表和字段，存取机制说明。

>

e）调用关系

[说明]

<本处描述调用和被调用关系，本方法被哪个或哪些实体主调，被调用或被触发方式；另外本方法调用的可执行程序公共函数库或函数，以及调用或触发方式。

>

f）算法

[说明]

<上述因素的具体逻辑关系准确描述，如内存数据构造的初始化公式，计算公式等，数据库表及字段与内存变量的对应等。

建议使用UML图并附上说明>

g）程序逻辑流程图

[说明]

<从程序出发，描述程序功能和算法的的逻辑流程图，建议使用UML图并附上说明>

4.2XXX子系统名称2

[说明]

<下一级章节如4.1.>。

。

。

5用户界面详细设计

<因为用户界面虽然也属于程序功能的一局部，但是多数系统的用户界面较为复杂和琐碎，需要将其与后台处理分开设计，包括数据库表设计。

用户界面是作为外部接口的一局部表达在概要设计中的。

本章着重设计用户界面的外观要素和界面处理流程，以及主要的界面级和界面事件级的约束。

控制台程序可以以文字说明，WEB或窗口程序建议以图片说明。

本处无文字。

>

5.1界面构造

5.1.1界面构造或菜单构造

5.1.1.1根本框架

5.1.1.2框架构造描述

●Container

“container“就是将页面中的所有元素包在一起的局部，这局部还可以命名为:

“wrapper“,“wrap“,“page“.

●Header

“header〞是页面的头部区域，一般来讲，它包含的logo和一些其他元素。

这局部还可以命名为:

“page-header〞（或pageHeader）.

●Navbar

“navbar“等同于横向的导航栏，是最典型的网页元素。

这局部还可以命名为:

“nav〞,“navigation〞,“nav-wrapper〞.

●Menu

“Menu〞区域包含一般的和菜单，这局部还可以命名为:

“subNav“,“links“，“sidebar-main〞.

●Main

“Main〞是网页的主要区域，所有业务的处理区域。

这局部还可以命名为:

“content“,“main-content〞（或“mainContent〞）。

●Footer

“Footer〞包含附加信息如软件的开发商信息或软件版本发布信息，这局部还可以命名为:

“copyright“

5.2界面设计及模块分析

5.2.1界面设计

1、采用CSS+DIV重构界面。

将界面数据表现和样式别离，提高页面浏览速度，不使用TABLE。

2、提供页面信息交互。

Ø提供操作结果确认

在提交数据，或是载有数据的页面关闭，或其他需要和用户进展确认交互的场景，需要软件能够提供一个以弹出页面形式，要求用户确认执行结果的对话框，例如：

提示确认输入信息正确：

弹出对话框，并将已填写的内容列出，要求用户确认内容的正确性，给出“确定〞和“取消〞的选择按钮；

a）与正在进展的操作无关的按钮应该加以屏蔽，例如：

按钮背景为灰色显示；

b）对可能造成数据无法恢复的操作必须提供确认信息，给用户放弃选择的时机；

c）非法的输入或操作应有足够的提示说明；

d）对运行过程中出现问题而引起错误的地方要有提示，让用户明白错误出处，防止形成无限期的等待；

Ø页面信息提示

在web页面提供的功能中，很多情况需要系统发送一些必要的提示信息到页面显示给用户，这些信息的分类有：

警告信息、制止信息、操作执行成功信息、操作执行失败信息、错误信息、提示信息。

这些信息在当前页面或弹出页面上显示。

如果采用弹出对话框的形式，对话框的页面构造如下列图：

●标题区：

简要给出此次提示信息的性质，例如：

提示：

确认提交！

●图标区：

给出和此次提示信息性质匹配的图标；

●提示信息区：

给出此次提示信息的具体内容；

●按钮区：

给出供用户进展选择的按钮，例如：

确认，取消；

对于对话框的背景颜色，要求和系统的整体风格选取的颜色一致，而右上角的操作区只保存关闭一个可操作功能，最小化和最大化的功能将不显示。

5.2.2触发方式

●界面通过点击左侧导航菜单，在右侧main〔参照5.1.1.2〕展示主要页面，显示数据，图表等内容等；

●按钮触发，通过点击页面上的按钮触发事件，如点击按钮显示页面等。

除了这两个主要的触发方式，系统还包含鼠标点击触发事件，悬浮鼠标等触发方式；

5.2.3系统模块设计分析

系统主要包块用户管理，数据管理，受众分析，受众查询，受众查询，数据输出，报表导出，系统管理等模块；

●用户管理主要用来添加，修改，删除用户，设置登陆用户；

●数据管理对数据源进展增删，新接入数据源那么增加，去掉数据源那么删除；对标签体系进展管理，包括标签和关键字的增删查改；对地区编码进展管理；

●受众分析主要以动态折线图的形式展示当前受众的数量变化趋势和以折线图和柱状图的形式展示受众在地域、行业上的分布态势；

●受众查询那么主要选择人群维度标签，根据已选项输出受众分布图和选择地区维度标签，根据已选条件输出受众分布图；

●数据输出主要根据查询条件，输出受众，手机输出IMEI或MAC，固网输出cookie；

●报表导出根据历史数据，生成受众分析和受众查询的报表供下载；

●系统管理提供系统设置和对系统的操作日志进展查询

6尚未解决的问题

7资源对象说明

[说明]

使用文字内容说明使用绘图工具的信息，版本。

需要将设计时使用的图的原始文件以对象方式插入文档，文件名中后缀版本与本文档版本一致。

其他较小资源也可以插入，较大资源可以给出svn。