02 系统设计文档示意必须有Word格式文档下载.docx

02 系统设计文档示意必须有Word格式文档下载.docx

《02 系统设计文档示意必须有Word格式文档下载.docx》由会员分享，可在线阅读，更多相关《02 系统设计文档示意必须有Word格式文档下载.docx（11页珍藏版）》请在冰豆网上搜索。

2.5.设计方法2

3.架构设计2

3.1.应用架构概述2

3.2.技术结构3

3.2.1.框架图3

3.2.2.描述3

3.3.策略3

3.4.功能组件3

4.类与数据结构设计4

5.用户界面设计4

5.1.用户界面风格描述4

5.2.主要用户界面描述4

6.工作流设计4

7.非功能性设计5

7.1.有效性及可恢复性5

7.2.灾难恢复及业务连续性5

7.3.可用性5

7.4.性能管理5

7.5.安全性5

7.6.可扩展性5

7.7.可支持性5

7.8.互用性5

7.9.兼容性5

7.10.其它非功能性设计5

8.测试及验收准则5

9.部署环境6

9.1.硬件环境6

9.2.软件环境6

9.3.服务6

10.关键技术示例6

10.1.关键技术1（名称）6

10.2.关键技术26

11.项目约定6

11.1.项目指南6

11.2.命名约定6

11.3.编码约定（可选）6

12.附录6

1.概述

1.1.编写目的

1、列出本文编写的主要目的。

2、本文的预期读者是谁？

1.2.项目背景

描述项目的背景：

1、待开发系统的名称。

2、系统的运行的社会环境。

3、技术环境。

4、本文档需要响应的主要问题。

5、本设计要解决的主要问题有：

列出主要问题

6、关键解决方案的驱动者

7、与旧系统比较其优点是……。

8、描述本系统的潜在用户是谁？

能从本系统获得的益处是什么？

1.3.系统概述

总体描述对设计有影响的系统的功能和内容。

1.4.系统目标

简要描述要完成什么功能以及基本的设计方法。

1.5.参考资料

名称

文件名

作者

1.6.术语和缩写

术语/缩写

定义

2.设计前考虑

2.1.假设和依赖

1、列出假设条件

2、列出设计必须考虑的所有外部系统、基础设施、工具、人、团队

相关软件或硬件

操作系统

典型用户特征

功能上可能的变化

3、将在本系统中重用的以前的设计或第三方库

4、将来可能用到当前系统的解决方案

2.2.风险

1、已知的风险和问题

2、未知风险和问题

2.3.设计原则

描述设计的目标和原则（可以是软件特性，如易用，性能等以及哪个优先）

2.4.设计约束

描述设计约束（标准、策略和在本设计中要遵循的指南）

2.5.设计方法

描述设计方法（OO或SD）

2.6.命名约定

描述设计过程中的命名约定

2.7.编码约定（可选）

描述本项目的编码规范，可参考公司的《编码规定》。

如果项目不编写详细设计文档则需要在本章节描述编码约定。

3.架构设计

3.1.应用架构概述

全面而且有一定层次结构地描述整个应用的“运行时功能”组成。

可从以下方面进行描述：

1、描述系统类型（CS、BS或者……）；

2、系统的运行平台；

3、主要的输入输出；

4、系统用户界面及风格；

5、部件（子系统或模块）之间的距离（如：

在不同计算机上、在局域网内，在互联网上，是分布式……）

6、粗略估算每个模块（线程、进程、客户端……）的实例数；

7、用框图描述模块与模块间关系；

8、外部接口、数据交换；

9、如果本项目中只包含一个系统，那么功能（用例、模块、系统）要素的组织必需在这里描述。

例如：

系统数据的操作、业务数据的增删改查、统计报表、外部接口等等；

10、如果含有工作流的系统，也要在这里描述工作流。

流程是应用组织的一种形式，必须描述。

这部分由于每个应用实现的功能不同，应该都不一样，无法重用。

类似用例图的细化。

3.2.技术结构

本章节是采用框架图及描述的形式从总体上对技术框架进行说明。

3.2.1.框架图

用图表方式描述主要组件以及各组件之间的关系，需要包括访问控制机制。

以prototype为例，可以重用prototype文档中的分层图，但如果有其他部件，应该修改

3.2.2.描述

详细描述主要组件及各子系统的设计方案，包括所使用的技术、标准、所支持的协议等。

3.3.策略

描述设计策略，包括系统架构设计的抽象机制；

（ORM也属于此类）

描述为什么会采用此策略，如何平衡各设计目标，以及各设计策略的优先级；

以上策略可以涉及以下几个方面（但是并不局限于以下几方面）：

1、所用到的特定的产品类型（编码语言、数据库、程序库……）；

2、所采用的可重用组件；

3、将来要进行的扩展和增强；

4、用户接口样式（或者系统输入输出模型）；

5、软硬件接口样式；

6、错误探测和恢复；

（采用tryexcept等）

7、内存管理策略；

8、外部数据库和数据仓库管理及持久化；

9、数据和控制的分布；

10、通用的控制方法；

11、并发和同步；

12、通讯机制；

13、其它资源的管理。

3.4.功能组件

给出以下设计中详细描述的功能组件列表。

（功能组件列表，或称功能模块列表）

4.类与数据结构设计

1、主要的类及它们之间的关系；

2、关键的交互；

3、关键算法；

4、数据库；

5、其它数据、文件等；

以上描述的内容请用图表的方式表达和描述（例如：

类图）：

5.工作流设计

系统中有用到工作流的需要描述。

可包括以下内容：

1、流程；

2、活动名称；

3、准入条件；

4、被执行的任务；

5、准出条件；

6、相关模块（可选）；

7、角色。

6.用户界面设计

这部分如果能在前期就给出界面原型可以直接用原型替代。

6.1.用户界面风格描述

用户界面风格应该参考用户特征，使用环境以及在业务需求及系统需求中描述的用户界面。

包括主要影响客户体验的字体颜色、大小……

6.2.主要用户界面描述

制作原型：

根据需求定义的功能和事件流，简单画出界面所需要的元素、位置、布局，要做的事情和怎么做这些事情，把它怎么和用户交互想清楚，而且把所有这些都画出来，让人可以直观地看到。

可包括如下内容：

1、主窗体；

2、菜单；

3、登录界面；

4、增删改查界面；

5、表单；

6、数据网格；

7、查询界面；

8、报表；

9、对话框；

7.非功能性设计

此处是针对系统非功能性需求而进行的设计。

建议考虑主要的非功能性需求，对应的设计内容

7.1.有效性及可恢复性

7.2.灾难恢复及业务连续性

7.3.可用性

7.4.性能管理

7.5.安全性

包括认证、授权、访问控制

7.6.可扩展性

7.7.可支持性

可从以下方面描写：

1、备份；

2、监测；

3、升级；

4、SLA监测；

5、工具；

6、支持合约。

7.8.互用性

7.9.兼容性

7.10.其它非功能性设计

8.测试及验收准则

9.部署环境

包括硬件、软件、服务。

应用图表的形式进行描述

ApplicationServer

CPU：

P43GHz

RAM：

1G

OS:

Win2000server＋sp4

Jboss4.2

JDK5

SQLServer

Win2003server＋sp1

SQLServer2000orabove

ClientSide

（sustainIE6，IE7，FIRFOX）

P42.66GHZ

512

MOS:

Winxp+sp2/IE6.0orabove

CPU:

x86Family6Model83AT/ATCOMPATIBLE

RAM:

256

Winxp+sp4/IE6.0

Pageresponsetimebetweentwoandthreesecond

9.1.硬件环境

9.2.软件环境

9.3.服务

10.关键技术示例

10.1.关键技术1（名称）

1、技术简介；

2、示例

3、样例代码（可用附件描述）

10.2.关键技术2

同10.1