不管你使用什么工具来显示你的架构。系统架够的文档是必不可少的。下面将是总结一些系统架构文档的一些特性,将系统架构的文档书写的一些特性定义为通用模式。
首先你要知道,完成一个系统架够的设计。该系统的Scope则是由需求来定义。因此参考需求分析文档时必备的。
下面总结格式如下:
[quote]
1. 显示架构相关人员,及其创建,修改,时间及其人员。
2. 描述系统的目的和需要解决的问题
3. 画出系统架构图,拓扑图。
4. 详细定义系统的行为
5. 描述系统的其他视图(如:物理视图,逻辑部件的映射与其他视图的关系)
6. 概念框架(对问题域以及架构概念的定义,概念之间的关系)
7. 总结(对整个架构过程的小结)
[/quote]
以上7个步骤犹如写议论文的三板斧。下面具体岁一些步骤进行细化
[quote]
2.1 系统上下文(系统的使用和问题的解决)
2.2 系统接口(系统提供的服务)
2.3 非功能性需求(质量,约束,规范--以及解决质量,约束,规范的方法和策略)
3.1 定义部件(描述架构中的部件,包括部件名称、提供的接口、与其它部件之间的交互等)
3.2 描述独立于部件的服务
4.1 各种系统用例或系统操作下架构的动态行为,相应外部的激发(usecase中称为场景)
4.2 对系统行为和部件协作的解释和文档化
5.1 过程视图(指定逻辑结构元素到控制线程来对系统进行分解,以执行任务和过程)
5.2 开发视图(系统代码的分解,如文件、库,以及代码部件之间的依赖关系)
5.3 物理视图(描述系统的部署)
[/quote]
综合7大条及其分条目来大致定义出一份架构文档需要显示的信息。
首先你要知道,完成一个系统架够的设计。该系统的Scope则是由需求来定义。因此参考需求分析文档时必备的。
下面总结格式如下:
[quote]
1. 显示架构相关人员,及其创建,修改,时间及其人员。
2. 描述系统的目的和需要解决的问题
3. 画出系统架构图,拓扑图。
4. 详细定义系统的行为
5. 描述系统的其他视图(如:物理视图,逻辑部件的映射与其他视图的关系)
6. 概念框架(对问题域以及架构概念的定义,概念之间的关系)
7. 总结(对整个架构过程的小结)
[/quote]
以上7个步骤犹如写议论文的三板斧。下面具体岁一些步骤进行细化
[quote]
2.1 系统上下文(系统的使用和问题的解决)
2.2 系统接口(系统提供的服务)
2.3 非功能性需求(质量,约束,规范--以及解决质量,约束,规范的方法和策略)
3.1 定义部件(描述架构中的部件,包括部件名称、提供的接口、与其它部件之间的交互等)
3.2 描述独立于部件的服务
4.1 各种系统用例或系统操作下架构的动态行为,相应外部的激发(usecase中称为场景)
4.2 对系统行为和部件协作的解释和文档化
5.1 过程视图(指定逻辑结构元素到控制线程来对系统进行分解,以执行任务和过程)
5.2 开发视图(系统代码的分解,如文件、库,以及代码部件之间的依赖关系)
5.3 物理视图(描述系统的部署)
[/quote]
综合7大条及其分条目来大致定义出一份架构文档需要显示的信息。