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脚本驱动的软件项目模块图形化表述思路

说明：

本文发布于: gitee,github,博客园
转载和引用请指明原作者和连接及出处.

正文：

说明：这里记录了如何使用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

转载于:https://www.cnblogs.com/taichu/p/9052219.html

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

中国电子学会2023年05月份青少年软件编程Scratch图形化等级考试试卷二级真题(含答案)
2023-05 Scratch二级真题题数:37 分数:100 测试时长:60min 一.单选题(共25题,共50分) 1.运行下列哪段程序,可以让狗狗走到木屋门口?(C)(2分) A. B. C. ...
几种优秀的屏幕录像软件用法介绍(图)
豪杰屏幕录像机V2.0共享版这是大名鼎鼎的豪杰公司出品的屏幕录像软件,功能强大而且操作简单. 要用它录制屏幕录像的话,首先需要设定一些参数.按一下界面右边的半月形按钮就会伸出"选项菜单&q ...
【跃迁之路】【473天】刻意练习系列232（2018.05.24）
@(跃迁之路)专栏叨叨两句技术的精进不能只是简单的刷题,而应该是不断的"刻意"练习该系列改版后正式纳入[跃迁之路]专栏,持续更新一.SQL [跃迁之路]SQL语句刻意练习( ...
2018.10.17考试
2018.10.17考试总结 1.咒语 (curse.pas/c/cpp) [题目描述] 亮亮梦到自己来到了魔法城堡, 但一扇巨大的石门阻拦了他通向城堡内的路.正当他沮丧之际,突然发现门上有一处机关, ...
java程序设置jvm_Java程序员应在2018年学习的3种JVM语言
java程序设置jvm 如果您是Java程序员,并且想学习更多的编程语言以扩展您的知识和技能,但是不确定选择哪种编程语言,那么您来对地方了. 在本文中,我将分享Java程序员可以在2018年学习的3种 ...
Java程序员应在2018年学习的3种JVM语言
如果您是Java程序员,并且想学习更多的编程语言以扩展您的知识和技能,但是不确定选择哪种编程语言,那么您来对地方了. 在本文中,我将分享Java程序员可以在2018年学习的3种JVM语言以及为什么要学 ...
2019年TI杯简易电路特性测试仪制作过程（2）——测量电路硬件设计 20/05/17
一.信号衰减输出部分设计 1.1增益测量时输入信号峰峰值选择通过计算待测的共射放大电路在1kHz频率下的增益大约在100以上,这个增益会根据不同的管子呈现出细微的不同,我手头搭建的电路经过测试发现此 ...
顺无盘linux win10包,(2018.05.21)云更新2016正式版x86_2016.10.15.4976无盘xp-win7x32-x64-win10x64公包...
官方2016.12.6更新版本修正各BUG (服务端支持x86 32位系统) Win10,ltsb企业版 2017.3.3更改三层地址,改善不配问题. 重新修改补丁,使其更稳定解决个别提示客户端配套问 ...
C# 2018.9.17
C# 2018.9.17 C#的优点: 1,不会有运行时崩溃,解决了C++的痛点一,难预防,难查错 2,使用文件不需要包含进来,只需要using namespace即可,解决了C++的痛点二,包含复杂 ...

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

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

OAA

目的

说明

使用

Example

END

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

最新文章

热门文章