`
Surmounting
  • 浏览: 67064 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

Shane版详细设计书 文档模板

阅读更多

XXXX 详细设计书

本文我也发表在 CSDN ,地址为:http://blog.csdn.net/shanelooli/article/details/7792865


1 XXXX介绍
1.1 背景与目的
<先介绍整体行业背景,再介绍项目开发背景,然后介绍开发此产品的目的,最后是编写本文档的目的>

1.2 适用范围
<包括XXXX的适用范围以及本文档的适用范围。其中本文档适用范围是指适用于什么角色的人做什么事情时候参考或据此作为标准>

1.3 参考资料
< 列举了编写本文档所参考的资料或其他资源。在这里应该给出详细的信息,包括标题的名称、作者、版本号、日期、出版单位或资料来源,以方便读者查阅这些文 献。必要时应说明何时以及如何得到的这些参考资料。需求分析说明书的参考文献可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文 档>

1.4 相关文档
<以相关的每个文档全名为三级标题。其中需要指明和本文档的关系。>

1.5 术语和缩略语
<列出本文档中用到的术语及缩写词,可以给出简要说明。
对文档中用到的重要符号或者格式约定给出定义和说明。
如果比较多,采用表格方式进行说明。>



2 系统综述
2.1 系统描述
2.1.1 功能
<根据需求分析总结的系统功能简述>
2.1.2 预期的环境
<包括剩余工程过程、实施过程的环境。包括编程开发环境、实施环境。这其中要指明有关各种约束;约束内容应遵循需求分析中的假定约束分析。>

2.2 预期执行情况
<对系统访问频率,实施之后系统运行情况进行描述;并指出希望能达到的效果。这其中包括一些核心子系统被频繁访问的并发度,以及适应实施过程中系统热迁移的有关考虑。>

2.3 针对性能需求的设计
<根据需求说明书中有关性能需求的内容,提出针对性的设计保证>

2.4 系统结构
<如果有条件应附带一份系统结构图。
包括对外交互、可访问和可被访问的接口等。>


2.5
总编程原则
<描述在编码规范基础上,针对本系统特别的编码原则。比如由于本系统将用于缺内存区域所以尽可能重用对象并使用无空数组型列表;或者由于访问对速度要求较高所以应尽可能多做数据缓存减少存储设备的输入输出等。>


3 素材详细设计
3.1 自建数据结构详细设计
3.1.1 自建数据结构一览
3.1.2 数据结构甲
3.1.2.1 数据结构甲概述
<包括这个数据结构是做什么用的,有什么要求>
3.1.2.2 设计思路
<描述如何根据概述中提到的此数据结构作用,而进行设计。可以引用常见的模式范例,或者描述设计此数据结构时产生的灵感。如必要,可以引入表格;事实上,多数数据结构的设计思路都非常简单,就是简单的“记录”二字。>
3.1.2.3 调用方法——接口方案
<描述此数据结构的实体应该怎么在程序中被使用。一般来说,对于爪哇语言(Java),这里甚至可以说“其仅仅使用空构造方法新建对象”即可。>
3.1.2.4 测试使用方案
<给出一个能够充分表现出次数据结构体效果的测试方案。可以是与其替代的传统数据结构进行比较,可以是并发模拟以验证其线程安全,等。>
3.1.2.5 程序结构
<用语言和算法表达式(伪代码)来描述数据结构程序体中具体的程序。描述粒度不应太大。应充分结合编码人员的工作能力,不造成编码人员过多的思考,也不产生详细设计人员过多的描述工作量。>
3.1.3 数据结构乙
<同 数据结构甲>

3.2 信息模型设计
< 信息模型是指通过可编程的数学方法描述业务问题的方法。比如业务是为用户赠送礼物,要求对更容易留住的用户进行赠送。那么可能需要抽取出一个“忠实度”的 值,通过用户日常登录次数、登录时间差的方差一类计算方法,形成一个函数。这种抽取过程称为“信息建模”。信息模型描述本系统需要用到的信息建模结 果。>

3.3 素材甲设计
3.3.1 素材甲概述
<描述素材甲的作用>
3.3.2 接口方案
<这包括素材甲需要建立的对外接口,以及素材甲和别的素材对接的程序内部接口。内部接口很可能依赖某些数据结构。>
3.3.3 测试方案
<设计测试程序以及测试方法,用来检测素材甲,以保证其能够达到使用要求。>
3.3.4 程序设计
<用语言和算法表达式(伪代码)来描述素材程序体中具体的程序。描述粒度不应太大。应充分结合编码人员的工作能力,不造成编码人员过多的思考,也不产生详细设计人员过多的描述工作量。
程序设计一般包括以下内容:
甲、程序结构描述。若是面向对象编程,则为描述各个对象的功能以及存在状态。
乙、程序详细过程描述:具体算法与程序逻辑。
丙、设备访问或输入输出调用方法、时机,调用时产生的数据流动方法与内容。
丁、异常、日志的处理方法。
戊、开发之前应明确但暂未明确的问题,称为“尚未解决的问题”,需专门指出>


3.4 素材乙设计
<同 素材甲设计>


4 界面详细设计
4.1 风格样例
<此处描述整体界面风格。通过罗列各个风格样例的样图使设计方案具体化。>

4.2 通用控件
<通用控件是指诸如按钮、标题、分割线等界面控件的样子。这里所说的“样子”包括颜色、渐变方式、边角、阴影等。>

4.3 界面布局(各界面)
<给出每个界面需要摆放的内容以及布局。可以通过坐标尺寸或相对尺寸来进行描述。布局设计应做到界面制作人员可以根据设计方案直接写出界面。>

4.4 特殊界面(各)
<此处描述具有特殊视觉效果的界面。这些界面不由通用控件组成。比如某系统用到,宇宙星空图,并从宇宙星空图转到各个星座的问答;这其中宇宙星空图就是特殊界面。>


5 XX子系统详细设计
5.1 程序结构
<描述子系统中各个模块的组合方式,以及素材的搭配方法。>

5.2 接口方案
<每个子系统的接口描述说明可参照以下格式:
接口编号、接口名称、输入、处理逻辑、输出
这里所说的接口特指此子系统对外的数据进入、传出途径,包括可被外界调用的方法,提供的服务以及输入输出方式。>


5.3 X模块设计
5.3.1 综述
<主要是说明此模块在子系统中的具体作用>
5.3.2 单元测试方案
<模块编写需要在测试程序指导下进行。测试程序是用程序模拟此模块的出入口,以检测模块是否能正确运行且性能达标。>
5.3.3 数据方案
<可以有数据流转图,一般用工具画,一定要屡清每个模块的数据流向,从哪儿到哪儿,做怎样处理等等>
5.3.4 界面选用
<如果本模块涉及到界面,这里指明选用的界面布局和具体控件>
5.3.5 组合方式
<根据概要设计分析出的功能块进行拆解,选择合用的素材。可以使用业务流程图配合时序图什么的…
需要给出程序调用、流转的过程,以指导编程人员做出符合设计的正确程序。>


5.4 Y模块设计
<同 X模块>


6 XY子系统详细设计
<同 XX子系统详细设计>

分享到:
评论

相关推荐

    软件详细设计文档模板(最全面).zip_基本设计与详细设计

    这份"软件详细设计文档模板(最全面).zip"包含了完成这一任务所需的全面资源,特别是其中的"软件详细设计文档模板(最全面).docx"文件,它将帮助我们深入理解如何构建高质量的详细设计文档。 详细设计文档的主要目标...

    2023年最新java开发详细设计文档模板

    Java 详细设计文档模板通常参考 Java 语言规范、软件开发流程、编程规范等。 2 程序系统的结构 程序系统的结构是软件系统的总体架构,描述了软件系统的组件、接口和交互关系。程序系统的结构通常包括软件系统的...

    软件详细设计文档模板(最全面)-详细设计文档.doc

    《软件详细设计文档模板》是IT行业中至关重要的一个环节,它是软件开发过程中的核心文档,为程序员提供了清晰的实现指南。这份文档详细记录了软件的各个组成部分,确保开发团队对软件设计有统一的理解,从而提高开发...

    2-软件概要设计文档模板.docx

    1. 规范化软件设计:软件概要设计文档模板提供了一个规范化的框架,帮助软件开发团队规范化软件设计的过程。 2. 提高软件质量:软件概要设计文档模板涵盖了软件设计的各个方面,帮助软件开发团队提高软件的质量和...

    软件详细设计文档模板

    软件详细设计文档模板 软件详细设计文档模板是软件开发过程中的一个重要组件,它提供了一个统一的模板,指导开发团队编写软件详细设计文档。该模板涵盖了软件详细设计的各个方面,包括引言、全局数据结构、模块设计...

    软件系统详细设计说明书模板

    软件系统详细设计说明书模板是软件开发项目中的一份非常重要的文档,它记录了软件系统的详细设计思路、架构设计、模块设计、数据库设计、接口设计等信息。通过阅读该文档,读者可以快速了解软件系统的详细设计,从而...

    软件系统详细设计文档模板(超级正规).doc

    XXX软件详细设计说明书 1 Revision Record 修订记录 2 1 引言 3 1.1 编写目的 3 1.2 背景 4 1.3 参考资料 4 1.4 术语定义及说明 4 2 设计概述 4 2.1 任务和目标 4 2.1.1 需求概述 4 2.1.2 运行环境概述 4 2.1.3 条件...

    (完整word版)软件详细设计文档模板.pdf

    1. 设计规范:详细设计文档模板通常会包含对软件设计中应该遵循的标准和规则的描述。比如编码标准、接口设计标准、数据库设计规则等。 2. 模块划分:在详细设计阶段,需要明确地划分软件系统中的各个模块以及它们...

    软件工程文档模板(完整规范版)

    软件工程文档模板(完整规范版) , 1. 范围 1 2. 总体要求 1 2.1 总体功能要求 1 2.2 软件开发平台要求 1 2.3 软件项目的开发实施过程管理要求 2 2.3.1 软件项目实施过程总体要求 2 2.3.2 软件项目实施变更要求 2 ...

    软件项目详细设计文档模板

    【软件项目详细设计文档模板】是软件开发过程中关键的一环,它为开发团队提供了清晰的指导,确保项目按预期进行。这份文档通常包含了项目的命名规则、总体结构、数据表与功能对应关系、源代码类与系统功能对应以及...

    ASPICE软件需求规范文档模板

    * 软件需求规范文档的用途:本文档为某项目的ECU软件需求文档,根据系统需求文档及系统架构设计文档来提出软件方面的需求,作为后续软件架构设计以及软件详细设计的依据。 * 术语与缩写:了解基本术语和缩写的定义,...

    网上书店文档模板(需求、概要设计、详细设计等)

    网上书店文档模板是软件开发过程中不可或缺的一部分,它们涵盖了项目的需求分析、概要设计、详细设计等多个关键阶段。这些模板为开发者提供了清晰的指导,确保项目的规范性和可维护性。以下是对这些文档模板的详细...

    华为软件详细设计模板.doc

    【华为软件详细设计模板】是华为公司在软件开发过程中使用的一种标准化文档模板,旨在规范软件的详细设计过程,确保设计质量并提高开发效率。该模板详细规定了设计文档的各个组成部分和格式,帮助开发者清晰地表达...

    数据库设计规范文档模板

    数据库设计规范文档模板

    详细设计文档模板——参考

    总结,详细设计文档是软件开发过程中的重要文档,通过提供“设计文档模板”,可以规范设计过程,提高开发效率和软件质量。模板的使用能够帮助开发者遵循一致的格式,确保文档的完整性,从而更好地实现软件项目的成功...

    软件系统详细设计说明书模板和范例

    4. **设计文档模板**:模板是为了规范和提高效率而准备的标准化文档格式。软件系统详细设计说明书模板一般包括封面、目录、引言、系统概述、模块设计、数据设计、界面设计、错误处理、参考资料等多个部分,每部分都...

    软件详细设计报告文档模板1.doc

    - **编写目的**:明确报告的意图,旨在详细描述软件系统的架构和组件,以便开发团队理解并遵循设计规范进行开发。 - **项目风险**:识别并评估可能影响项目进度和质量的风险因素,如技术难题、时间限制、资源不足...

    软件设计文档模板.rar

    "软件设计文档模板.rar" 提供了一套全面的模板,涵盖了软件开发的各个阶段,帮助开发者遵循标准流程,提高工作效率。下面将对这些文档模板的重要性和具体内容进行详细介绍。 1. **操作手册**:操作手册是用户与软件...

Global site tag (gtag.js) - Google Analytics