系统设计说明书(架构、概要、详细)目录结构

虽然这些文档一般来说公司都是有模板的，但我写这些文档以来基本上是每写一次就把目录结构给改一次，应该说这是因为自己对这些文档的理解开始加深，慢慢的越来越明白这些文档的作用和其中需要阐述的东西，觉得这三份文档主要阐述了一个系统的设计和实现过程，从系统分解为层次、层次内的模块以及相互的接口、模块分解为对象以及对象的接口、实现这些对象接口的方法。这次又整了一份，^_^，欢迎大家指正。

XXX架构设计说明书

(架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系)

一. 概述

描述本文的参考依据、资料以及大概内容。

二. 目的

描述本文编写的目的。

三. 架构设计

阐明进行架构设计的总体原则，如对问题域的分析方法。

3.1. 架构分析

对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。

3.2. 设计思想

阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的实际情况而定。

3.3. 架构体系

根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。

3.4. 模块划分

根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模块依赖图。

3.4.1. 模块描述

根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。。

3.4.2. 模块接口设计

对模块接口进行设计，并提供一定的伪代码。

XXX概要设计说明书

(概要设计重点在于将模块分解为对象并阐明对象之间的关系)

一. 概述

描述本文的参考依据、资料以及大概内容。

二. 目的

描述本文的编写目的。

三. 模块概要设计

引用架构设计说明书中的模块图，并阐述对于模块进行设计的大致思路。

3.1. 设计思想

阐明概要设计的思想，概要设计的思想通常是涉及设计模式的。

3.2. 模块A

3.2.1. 概要设计

根据该模块的职责对模块进行概要设计(分解模块为对象、描述对象的职责以及声明对象之间的接口)，绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图，分别加以描述并相应的描述模块异常的处理方法。

3.2.2. 模块接口实现

阐明对于架构设计中定义的模块接口的实现的设计。

XXX详细设计说明书

(详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述如何实现)

一. 概述

阐述本文的参考依据、资料以及大概内容。

二. 目的

阐述本文的编写目的。

三. 模块详细设计

3.1. 设计思想

阐述对模块进行详细设计的思想。

3.2. 模块A

3.2.1. 详细设计

根据模块概要设计详细描述对于模块内对象的实现，包括对象的职责、属性、方法、对象内功能的流程图、对象关联的类、对象的异常。(需要绘制的主要为类图)

参考：http://www.blogjava.net/BlueDavy/archive/2005/06/13/6037.html

系统设计说明书(架构、概要、详细)目录结构相关推荐

【 Vue全家桶 · Vue CLI（四）】Vue项目的详细目录结构解析
文章目录前言 -- 一级目录解析一. dist 二. node_modules 三. public 四. src(基础版) 4.1 main.js 4.2 App.vue 4.3 src / as ...
Hadoop——（Hadoop框架，Hadoop的优缺点，Hadoop1.x和2.x的版本区别，Hadoop架构，Hadoop目录结构）
文章目录大数据的简介 Hadoop框架 Hadoop的优缺点 Hadoop1.x和2.x的版本区别 Hadoop架构 Hadoop目录结构正常工作的Hadoop集群中Hadoop都分别需要启动哪些 ...
html 项目目录架构,前端项目目录结构规范.pdf
前端项目目录结构规范前前端端项项目目目目录录结结构构规规范范简简介介该文档主要的设计目标是项目开发的目录结构保持一致,使容易理解并方构建与管理. 要要求求在本文档中,使用的关键字会以中文 ...
DDD领域驱动设计实战-分层架构及代码目录结构
代码结构 DDD并没有给出标准的代码模型,不同的人可能会有不同理解. 按DDD分层架构的分层职责定义,在代码模型里分别为用户接口层.应用层.领域层和基础层,建立了 interfaces.applica ...
android操作系统详细目录结构
\system\app 这个里面主要存放的是常规下载的应用程序,可以看到都是以APK格式结尾的文件.在这个文件夹下的程序为系统默认的组件,自己安装的软件将不会出现在这里,而是\data\文件夹中.下面 ...
前端架构，前端架构组织结构，目录结构架构
[编者按]本文作者Matt Carella为我们讲解了如何构建一个良好的架构.除了选择正确的工具以外,在组织工作流中遵循清晰整洁的原则对于我们来说是非常重要的.或许有的人会觉得文中所说的是在DOS时代 ...
Android详细目录结构
1 Android 2.1 2 |--Makefile3 |--bionic (bionic C库)4 |--bootable (启动引导相关代码)5 |--build (存放系统编译规则及gener ...
Angular入门到精通系列教程（15）- 目录结构（工程结构）推荐
文章目录 1. 概要 2. 目录结构(工程结构)推荐 2.1. 总的原则 2.2. 实例 2.3. 共享模块-SharedModule 3. 高级应用 - angular库.工作空间(workspac ...
安卓系统之旅——最全的Android源码目录结构
android平台四层架构对应源代码中的目录: 第一层:应用程序层(applications)对应根目录下packages/apps 第二层:应用程序框架层(application framework ...

系统设计说明书(架构、概要、详细)目录结构

系统设计说明书(架构、概要、详细)目录结构

系统设计说明书(架构、概要、详细)目录结构相关推荐

最新文章

热门文章