2018-05-17-OAA-一种mermaid脚本驱动的软件项目模块图形化表述思路



layout: post

title: 2018-05-17-OAA-一种mermaid脚本驱动的软件项目模块图形化表述思路

key: 20180517

tags: OAA flow chart sequence diagram 泳道图 时序图 图表 OAA PM Master

modify_date: 05-17

---

OAA-一种mermaid脚本驱动的软件项目模块图形化表述思路

说明:

正文:

  • 说明:这里记录了如何使用mermaid脚本语言来作图,从而更清晰明了的表述软件项目的模块关系及信令数据交互流程,作为软件工程和管理的一种必备手段和方法论建议。

OAA

目的

  • “OAA”即“One Picture Above All”,含义是“一张图,胜千言”。
  • 我们期望用脚本语言来画图,并方便观看,而图是描述信令流和数据流的好方法。
  • 我们只考虑两种图:“flow chart”流程图和“sequence diagram”时序图(也叫“泳道图)。
    • “flow chart”:描述组网拓扑结构和模块实体间的关系;
    • “sequence diagram”:描述多个网元之间回合制的信令和数据交互的时序信息;
  • 结合使用这两张图,一般就能描述绝大多数的工程和项目场景。
  • 用mermaid脚本语言还有格外的好处如下:
  • 脚本语言,容易编辑和维护,比二进制的诸如word/powerpoint,及图形JPG要方便;
  • 基于字符串,方便合并,观察,版本维护,放入GIT/SVN非常的小;
  • 文件小,方便随意的黏贴,拷贝,交互,传输,讨论和修改;
  • 总之,OAA是一种态度和方法论,用不用随你项目和人力而定,建议使用;

说明

  • 本项目是作为脚本作图语言mermaid的一个使用的例子,方便使用者继续创作脚本图;
  • 信息:
  • mermaid官网
  • mermaid在线测试
  • mermaid源码@github(可惜的是release发布到7.0.0只有就没了,作者似乎不在github维护了!)
  • mermaid源码@https://unpkg.com/[email protected]/dist/,请自行选择版本;
    • 其中“dist”目录用于JS当中的CDN方式引用“mermaid.min.js”等;
    • 其中“src”目录用于查看源码(比如github上不维护的版本新!已经到了8.X版本了!)
    • 另外,源码中作者用scss的格式存放可编译的css的源码,scss文件可以通过指定的编译器生成为目标css。
  • CDN调用方式如下:
<script src="https://unpkg.com/[email protected]/dist/mermaid.min.js"></script>

使用

  • 请从[email protected]项目查看具体情况,建议项目经理PM或敏捷开发Master可以了解下。

Example

  • 详见具体上面开源项目

END

原文地址:https://www.cnblogs.com/taichu/p/9052219.html

时间: 2024-11-10 14:32:58

2018-05-17-OAA-一种mermaid脚本驱动的软件项目模块图形化表述思路的相关文章

2018.05.17

今天去上了一节情商管理课程,实话实说,是我从小到大感触收获应该是最多的一门心理学课程,急着想回来写感受,所以课后没有找老师单独谈谈. 课上老师主要讲的是人的10种常见的心理歪曲,关于这10种心理歪曲我之后再慢慢整理,这里只想先记录下我的感想. 首先我会发现在这10种心理扭曲中,应该说70%以上成分都实际上是人针对自己所产生的一种我称作为"自我攻击性"的心理行为.主要的表现就是对自己总是要求很高,认为自己不如别人,放大消极的影响和情绪,从而让自己情绪处于一种消极状态,产生一种"

信息安全系15级学生课程设计——2018.05 小组课题报告

信息安全系15级学生课程设计--2018.05 小组课题报告 课题:物联网实训·远程安防监控系统 一.设计方案及可行性分析 1.项目概述 本项目需要实现以嵌入式Web服务器为核心的视频监控系统. 摄像头采集的到的图像经过压缩后,传到内置的web服务器中.用户只需要通过浏览器就可以观看摄像头采集到的数据. 除了视频监控功能外,本项目还可以搜集空气湿度.空气温度.光照强度等信息. 2.系统架构 该项目基本可以看作B/S架构,由有三部分组成: (1)核心服务端:其实是客户端(严格意义上说,PC上的浏览

Intel Digital Innovation Industry Summit(2018.08.17)

时间:2018.08.17地点:北京金隅喜来登大酒店 原文地址:https://www.cnblogs.com/xuefeng1982/p/10331638.html

Microsoft Artificial Intelligence Conference(2018.05.21)

时间:2018.05.21地点:北京嘉丽大酒店 原文地址:https://www.cnblogs.com/xuefeng1982/p/10335943.html

4.13日第12次作业,16章外包,17章需求,19章组织级与大型项目

29-高项-田哲琦 16章.外包管理 1.外包的形式有哪五种?什么是利益关系?P346-348 答:企业现行采用的主要外包形式如下: 1).活动外包 2).服务外包 3).内包 4).合包 5).利益关系. 利益关系(benfit-based relationship),这是一种长期合作关系,双方先为此关系进行投资,再根据预先拟定的协议分享利益,共同承担风险,同时共享利益. 2.外包管理的目标是什么?要实现这个目标,对外包管理提出哪四个方面的要求?P348 答:软件外包管理总的目标是用强有力的手

选一种你比较熟悉的软件,并点评它的优缺点,并描述此类软件的发展历史

windows操作系统, 优点:图形化界面能够更加便捷的对文件进行处理 缺点:容易被黑客破解从而导致信息的丢失 发展历史: 1.Windows是由微软在1983年11月宣布,并在两年后(1985年11月)发行的. 2.Windows版本2.0是在1987.11正式在市场上推出的.该版本对使用者界面做了一些改进.2.0版本还增强了键盘和鼠标界面,特别是加入了功能表和对话框. 3.Windows3.0是在1990年5月22日发布的,它将Win/286和Win/386结合到同一种产品中.Windows

strus2中获取表单数据 两种方式 属性驱动 和模型驱动

strus2中获取表单数据 两种方式 属性驱动 和模型驱动 属性驱动 /** * 当前请求的action在栈顶,ss是栈顶的元素,所以可以利用setValue方法赋值* 如果一个属性在对象栈,在页面上可以根据name属性进行回显*/ /** * 属性驱动实现的条件:* 1.当前请求的action在栈顶,所以action中的属性就暴漏出来了* 2.获取页面上表单的元素,整合成一个map * 3.调用setValue方法赋值*/ 1 package cn.itcast.struts2.sh; 2 3

敏捷软件开发:原则、模式与实践——第16章 对象图、第17章 用例、第18章 顺序图

第16章 对象图 有时,呈现出系统在某个特定时刻的状态是非常有用的.和一个正在运行系统的快照类似.UML对象图展示了在一个给定时刻获取到的对象.关系和属性值. 不过,你应该对花太多的对象图保持警惕.在大部分的情况下,它们都可以从相应的类图中直接推导出来,因此没有多少用处. 第17章 用例 在所有的UML图中,用例图是最令人迷惑也是最没有用处的.我建议出来系统边界外,忽略掉所有其他的图.系统边界图示例如下: 大矩形是系统边界.矩形内的所有东西都是将要开发的系统的组成部分.矩形外面是操作系统的参与者

Linux图形化界面的安装以及脚本

因为有些人安装的只是Linux内核版本的操作系统,所以今天把如何在内核版本中安装图形化界面的安装步骤写出来跟大家交流一下. 其中使用到的软件putty,一个简单的小终端,无需安装打开即可使用,下载地址:http://down.51cto.com/data/2041881 首先是登录到操作系统的字符界面. 然后需要说明的是:我要用另外一个叫做"putty"的小终端来连接Linux,因为putty连接更友好,所以先设置IP地址. 使用上面的命令进入vi编辑器之后,输入"i&quo