文档章节

架构设计【说文档】- 系列 1: 为什么要写【架构文档】?

止静
 止静
发布于 2014/10/23 10:33
字数 711
阅读 173
收藏 0

本章主题:

            回答一些与文档有关的问题。对于文档的重要性有思想上认知。

阅读人群:

            目前正在写文档的Coder。


1: 为什么一定要写文档,写好架构设计的文档,哪怕当前的系统在你看来非常简单

            有文档有助于不同利益相关的人员进行有效的沟通。

            有文档的架构可以在将来人员流转以后,追溯产品的上下文,

            有文档的架构可以交流自身对于架构的各种观点

            有文档的架构有助于从一个现有的架构转换到一个新的架构。

            有文档的架构可以提醒架构师,真切的梳理好背后架构的逻辑,以至于达到理性的认识。

           有文档的架构有助于识别哪些资源可重用以及可重用的时机。

            

2:写文档之前一些有必要的思考?

        1 :识别 利益相关者,清晰的知道文档的受众是谁?

        2:选择观点,写作的切入点。

        3: 如何组织?

        4:  添加和删除是否方便?


 3:编写软件架构文档的视点有哪些?

    答:

        视点分为两类,分别是基础视点和交叉视点。其中基本视点的类型有四种,分别为:

        (1)功能性视点:它关注支持系统功能性的元素。

        (2)部署视点:它关注支持系统分布的元素。

        (3)需求视点:为形成架构的系统需求提供说明,它包括功能性需求、品质和约束。

        (4)确认视点:为系统提供必需的功能、展示必需的品质和适应定义的约束提供说明。

        交叉视点是从某一特定功能的视点出发,与基础视点交叉综合关注的元素,下图为一交叉视点的例子。


4:软件架构通常要描述框架,应该从哪些角度去描述?

    答:

        多重视图和场景视图的使用。

        实现层级。

        交叉关注。

    问:软件架构的4+1视图模型是什么?

        答:

        软件架构的4+1视图是指逻辑视图、开发视图、过程视图、物理视图和场景(视图)。

        逻辑视图是设计的对象模型。

        过程视图获取设计的并发和同步方面的信息。

        开发视图描述的是软件开发环境中的软件静态组织。

        物理视图描述了软件与硬件之间的映射,还反映了它在分布式方面的信息。

         







© 著作权归作者所有

止静
粉丝 122
博文 134
码字总数 125762
作品 0
东城
技术主管
私信 提问
C#进阶系列——DDD领域驱动设计初探(一):聚合

原文:C#进阶系列——DDD领域驱动设计初探(一):聚合 前言:又有差不多半个月没写点什么了,感觉这样很对不起自己似的。今天看到一篇博文里面写道:越是忙人越有时间写博客。呵呵,似乎有点...

杰克.陈
2017/12/19
0
0
Asyncdb(一):写一个纯函数式的Mysql异步驱动

本文由 GodPan 发表在 ScalaCool 团队博客。 之前的 Akka系列博客 接下去可能并不会经常更新了,但是后续看到一些好的点或者大家对哪些还是比较感兴趣还会继续写几篇,这里先跟大家说明一下。...

ScalaCool
2017/10/09
0
0
大数据和云计算技术周报(第0期)

写在第0期周报 Q1:为什么要搞一个周报: A1:受众多社区日报、周报的启发(如湾区日报,ES日报等等),所以大数据和云计算技术社区经过众多讨论,也决定搞一个周报。目的很简单,营造分享的...

znzqhb07nr
2017/11/20
0
0
Do it early, do it often, do it automatically (转)

 上篇博客转眼已是半年前的了,最近有两个原因,促使我再次写博:   一是深深感到,在软件开发行业,有很多我认为已经是“常识性”的东西,可是对很多团队却完全没有体会。敏捷软件开发已...

云栖希望。
2017/12/04
0
0
搞全闪存阵列的各执一词 宏杉说别吵了,就用我哒

全闪存阵列也许十分诱人,但并不是每一个全部使用闪存介质的存储阵列,都称得上"纯粹的全闪存阵列",它们中的许多,并不完美。 "尺有所长,寸有所短",在企业级存储市场,产品指标上略有不同...

玄学酱
2018/05/18
0
0

没有更多内容

加载失败,请刷新页面

加载更多

2020,向死而生

或许2020年注定是非常艰难的一年,毕竟两个轮回前之的1900年,清廷过得也很艰难,义和团在北方闹得轰轰烈烈,紫禁城也被八国联军占领。次年(1901年)即签订了后世所谓的丧权辱国的辛丑条约,...

嘉树
7分钟前
0
0
git 常用配置

git config --global core.compression 0 git config --global http.lowSpeedLimit 0 git config --global http.lowSpeedTime 999999 git config --global http.postBuffer 524288000......

老码农008
8分钟前
2
0
Protel99SE WIN10系统下无法添加封装库的解决方法

Protel99SE WIN10系统下无法添加封装库的解决方法 Protel99SE这款PCB设计软件实在太古老了,导致与微软的最新操作系统有些功能不能兼容,比如WIN10系统下无法添加封装库;但是由于Protel99S...

demyar
9分钟前
1
0
大数据风控系统概述

为什么要做风控系统 不做的话,会有以下风险: 各种小号、垃圾账号泛滥 撞库攻击、盗号、毁号、拖库等 拉新 10w 留存率不到 5% 百万营销费用,却增加不了用户粘性 投票票数差距非常悬殊 各种...

大数据技术进阶
10分钟前
3
0
串口调试助手,VB6.0开发

1、为什么要自己开发一个串口调试助手 通常我们都是:在网上直接下载一个串口助手,可执行文件,直接使用,并无法得到其源码,在此我们提供了一个VB6.0开发的串口助手: (1)让你极速掌握串...

superman150
13分钟前
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部