向架构师进军--->怎样编写软件架构文档

时间:2022-12-11 19:13:18

假设你对项目管理、系统架构有兴趣,请加微信订阅号“softjg”,增加这个PM、架构师的大家庭

向架构师进军--->怎样编写软件架构文档

问:为什么要编写软件架构文档,它的优点是什么?

答:

有文档的架构有助于不同利益相关者之间进行有效的沟通。

有文档的架构能够提供追溯其它工作产品的上下文。

有文档的架构能够传达可供选择的架构解决方式。

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

有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划。

有文档的架构能够提醒架构师在其所作的某些决定背后的基本原理。

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

有文档的架构有助于架构的评估。

问:编写软件架构文档的步骤是什么?

答:

识别利益相关者组。

选择视点。

创建工作产品。

给架构描写叙述打包。

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

答:

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

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

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

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

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

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

向架构师进军--->怎样编写软件架构文档

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

答:

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

实现层级。

交叉关注。

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

答:

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

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

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

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

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

假设你对项目管理、系统架构有兴趣,请加微信订阅号“softjg”,增加这个PM、架构师的大家庭

向架构师进军--->怎样编写软件架构文档

向架构师进军--->怎样编写软件架构文档的更多相关文章

  1. 向架构师进军--->如何编写软件架构文档

    如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的好处是什么? 答: 有文档的架构有助于不同利益相关 ...

  2. 使用vim编写hexo文档,并用ultisnips/snipmates/snippets插件补全

    作为一个vim使用者,编写markdown文档时若不能用vim这怎么能受的了! 下面是我编写markdown的时候用到的插件 Plugin 'Markdown'Plugin 'Markdown-syn ...

  3. 基于 Markdown 编写接口文档

    最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而 ...

  4. 使用 Laravel-Swagger 编写接口文档(php)

    使用 Laravel-Swagger 编写接口文档 Table of Contents Swagger 文档管理 官方网站:https://swagger.io/ 快速编写你的 RESTFUL API ...

  5. Win10环境下,告别MarkdownPad,用Notepad++搭建编写md文档的环境

    1. 为什么抛弃MarkdownPad 2 ? MarkdownPad坊间号称 Windows 环境下最好用的markdown编辑器-EXO me??? 博主入MarkdownPad 2 坑就是因为这 ...

  6. 作为Java开发工程师,如何高效优雅地编写接口文档

    作为一名优秀的Java开发工程师,编写接口文档向来是一件很头疼的事情.本来就被bug纠缠的很累了,你还让我干这? 其实,你可以试试ApiPost. ApiPost的定位是Postman+Swagger ...

  7. 向架构师进军--->系统架构设计基础知识

    如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 在讲解系统架构设计之前,有必要补充一下架构相关的概念,因此本博文主要讲述架构.架构师 ...

  8. 向架构师进军--->系统架构设计基础知识

    假设你对项目管理.系统架构有兴趣,请加微信订阅号“softjg”,增加这个PM.架构师的大家庭 在解说系统架构设计之前,有必要补充一下架构相关的概念,因此本博文主要讲述架构.架构师和架构设计等相关的概 ...

  9. 向架构师进军-->可重用架构资源

    如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 软件架构有三个主要来源:拿取.方法以及直觉.拿取也就是可重用资源.对于一个标准的系统 ...

随机推荐

  1. android support的作用及其常见错误的解决

    *:first-child { margin-top: 0 !important; } body>*:last-child { margin-bottom: 0 !important; } /* ...

  2. new XMLHttpRequest()和页面关系

    1.  三个页面分别对应"自己“的异步对象(3个) <title></title> <script type="text/javascript&quo ...

  3. 纯js写图片轮播插件

    最近终于写成了自己创作的图片轮播插件,使用原生js编写.与目前网上流行的轮播插件相比,功能和效果稍弱,但是使用起来相当方便. 先看html代码 <!DOCTYPE html> <ht ...

  4. 简析LIVE555中的延时队列

    http://www.cnblogs.com/nightwatcher/archive/2011/04/10/2011158.html 最近在看LIVE555的源码,感觉其中的延时队列写的不错,于是就 ...

  5. C&num;实现动态网站伪静态,使seo更友好

    本教程将使用Visual Studio 2013手把手教你实现webform动态页面的伪静态.本教程配套的C#源码工程可通过我的github下载.地址:https://github.com/shell ...

  6. TOMCAT 优化设置

    增加JVM堆内存大小修复JRE内存泄漏线程池设置压缩数据库性能调优Tomcat本地库 第1步 – 提高JVM栈内存Increase JVM heap memory 你使用过tomcat的话,简单的说就 ...

  7. python自定义库文件路径

    各有各的小烦恼,各有的小期待 这是人家私事,不要大嘴巴 在Pycharm中import whois时,总是失败 原因是安装了python3.x相关操作过程,将环境变量path中关于Python的配置c ...

  8. (三)Installation

    Elasticsearch requires at least Java 8. Specifically as of this writing, it is recommended that you ...

  9. docker镜像导入导出

    1.使用 save命令将 镜像保存为文件docker save -o  自定义文件名.tar  已存在的镜像名 2.使用load命令将镜像文件保存到本地仓库docker load -i 自定义文件名. ...

  10. RN animated缩放动画

    效果图: 代码: import React, {Component} from 'react'; import { AppRegistry, StyleSheet, Text, Animated, T ...