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/mermaid@xxx/dist/,请自行选择版本;
      • 其中“dist”目录用于JS当中的CDN方式引用“mermaid.min.js”等;
      • 其中“src”目录用于查看源码(比如github上不维护的版本新!已经到了8.X版本了!)
      • 另外,源码中作者用scss的格式存放可编译的css的源码,scss文件可以通过指定的编译器生成为目标css。
    • CDN调用方式如下:
<script src="https://unpkg.com/mermaid@8.0.0-rc.8/dist/mermaid.min.js"></script>

使用

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

Example

  • 详见具体上面开源项目

END

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

  1. 2018.05.17 nace关于采购订单的配置笔记

    由于公司的打印都是使用nast作为记录表,在给日企中国客户做扩展时单独配置了一下nace的设置 ZM01作为采购订单批量打印的输出类型,ZM02作为采购订单创建变更时输出的pdf打印输出类型 1.TC ...

  2. 【2018.05.11 智能驾驶/汽车电子】非技术向:关于Simulink和AutoSar的几种观点

    最近看到几篇关于Simulink及AutoSar的Blog和Paper,感觉比较有意思,转载备忘之. 1. 看衰Simulink及AutoSar From:Tumiz的技术天地 https://blo ...

  3. Microsoft Artificial Intelligence Conference(2018.05.21)

    时间:2018.05.21地点:北京嘉丽大酒店

  4. International Programming Retreat Day(2018.11.17)

    时间:2018.11.17地点:北京国华投资大厦

  5. Dell Technology Summit(2018.10.17)

    时间:2018.10.17地点:北京国家会议中心

  6. Intel Digital Innovation Industry Summit(2018.08.17)

    时间:2018.08.17地点:北京金隅喜来登大酒店

  7. 调试大叔V2.1.0(2018.12.17)|http/s接口调试、数据分析程序员辅助开发神器

    2018.12.17 - 调试大叔 V2.1.0*升级http通讯协议版本,完美解决Set-Cookie引起的系列问题:*新增Content-Type编码格式参数,支持保存(解决模拟不同网站或手机请求 ...

  8. 中美贸易战再次开启,世界两极化进程正在加快形成!..... Copyright: 1688澳洲新闻网 Read more at: https://www.1688.com.au/world/international/2018/06/17/369368/

    中美贸易战再次开启,世界两极化进程正在加快形成! https://www.1688.com.au/world/international/2018/06/17/369368/

  9. 使用2种python脚本工具将2个txt文档中的文字进行比较,并计算出Corr, WER正确率,准确率

    一.准备: linux服务器,src2mlf.py   rec2mlf.py   HResults文件,1份源文件和1份需要对比的文件.文件放置于本人云盘 二.使用方法: 1. 对比工具 HResul ...

随机推荐

  1. REST(Representational State Transfer表述性状态转移)

    参考内容:http://www.csdn.net/article/2013-06-13/2815744-RESTful-API 定义了一组体系架构原则,您可以根据这些原则设计以系统资源为中心的 Web ...

  2. mysql清空表

    清空某个mysql表中所有内容 delete from 表名; truncate table 表名; 不带where参数的delete语句可以删除mysql表中所有内容,使用truncate tabl ...

  3. 数据结构---队列C语言实现

    #include <stdio.h> #include <stdlib.h> //队列大小 #define SIZE 1024 static int queue[SIZE] = ...

  4. “万能数据库查询分析器” 5.03发布,访问EXCEL将自动为表名前后加上中括弧

        "万能数据库查询分析器" 5.03发布,访问EXCEL将自动为表名前后加上中括弧 1          引言    中国本土程序员马根峰推出的个人作品----万能数据库查询 ...

  5. 锋利的Jquery摘要

    一本好书值得去反复回味 第一章: jquery中的$(document).ready(function(){})与js中的windows.onload()的比较   $(document).ready ...

  6. partition List(划分链表)

    Given a linked list and a value x, partition it such that all nodes less than x come before nodes gr ...

  7. 东方国信 - 软件开发人员面试问卷(ver1.001.002)

    1.    通用编程知识问卷(所有编程人员必做)... 1 1.1      SQL问卷... 1 1.2      翻译... 2 2.    Java问卷(Java程序员应答,其他跳过)... 2 ...

  8. javax.mail

    摘抄 example: public static void sendEmail(ConfBean cBean, String filename, String filepath) { try { P ...

  9. DDD学习笔记1——分层架构

    新旧架构对比图: DDD中的基础设施层包括数据持久化(ORM数据访问),IoC容器实现,AOP实现(安全,日志记录,缓存等) Repository的接口通常放在领域层,具体实现在基础设施层 旧架构的业 ...

  10. 走进netty

    三月份开始看公司RPC框架的源码,发现如果要折腾明白,网络通讯这块知识必不可少.于是从如下几点开始逐步研究. 一.基础知识篇 1.Unix下5种I/O模型 Linux的内核将所有外部设备都看作一个文件 ...