[toc]

Mermaid

流程图 graph的基本用法

基础

  1. graph图开头要以graph TD从上到下或graph LR从左到右graph RL从右到左开头，代表画图的顺序
  2. 带方向的链接需要最少两个-和一个>，-的数量代表连线的长度，如A -----> B
  3. 带方向的链接需要最少三个个-，-的数量代表连线的长度，如A ----- B
  • 图的方向支持一下几种方式：
1
2
3
4
5
6
7
graph LR

TB - 从上到下(top buttom)
BT - 从下到上(buttom top)
LR - 从左到右(left right)
RL - 从右到左(right left)
TD - 跟 TB 相同
  • 三种线类型
1
2
3
--- : 实现
-.- : 虚线
=== : 粗线
  • 虚线带箭头的话加 > ，实线和粗线则最后一个字符替换成 >
  • 注释的两种写法(中间加注释，后边加注释)
1
2
-- 中间加注释写法 -->
-->|后边加注释写法|
  • 文本框类型
1
2
3
4
[] - 方形文本框
{} - 菱形文本框
() - 边角圆滑文本框
(()) - 圆形文本框
  • 子图
1
2
3
subgraph 子图标题
  子图开始 --> 子图结束
end

子图

1
2
3
4
graph BT
subgraph 子图标题
子图开始 --> 子图结束
end
graph TD subgraph 子图标题 子图开始 --> 子图结束 end 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
graph LR
  单独节点
  开始 -- 带注释写法1 --> 结束
  开始 -->|带注释写法2| 结束
  实线开始 --- 实线结束
  实线开始 --> 实线结束
  实线开始 -->|带注释| 实线结束
  虚线开始 -.- 虚线结束
  虚线开始 -.-> 虚线结束
  虚线开始 -.->|带注释| 虚线结束
  粗线开始 === 粗线结束
  粗线开始 ==> 粗线结束
  粗线开始 ==>|带注释| 粗线结束
  subgraph 子图标题
    子图开始 --> 子图结束
  end
  节点1[方形文本框] --> 节点2{菱形文本框}
  节点3(括号文本框) --> 节点4((圆形文本框))
graph LR 单独节点 开始 -- 带注释写法1 --> 结束 开始 -->|带注释写法2| 结束 实线开始 --- 实线结束 实线开始 --> 实线结束 实线开始 -->|带注释| 实线结束 虚线开始 -.- 虚线结束 虚线开始 -.-> 虚线结束 虚线开始 -.->|带注释| 虚线结束 粗线开始 === 粗线结束 粗线开始 ==> 粗线结束 粗线开始 ==>|带注释| 粗线结束 subgraph 子图标题 子图开始 --> 子图结束 end 节点1[方形文本框] --> 节点2{菱形文本框} 节点3(括号文本框) --> 节点4((圆形文本框))

英文单词缩写

四种布局方向的值是英文单词首字母大写缩写形式,默认仅支持垂直方向.

中文 英文 示例
图解 graph graph 流程图类型标识
子图 subgraph subgraph 嵌套子流程图标识
上 top TB 或 BT ,从上到下或从下到上的布局方向
下 bottom BT 或 TB,从下到上或从上到下的布局方向
左 left LR 或 RL,从左往右或从右往左的布局方向
右 right RL 或 LR,从右往左或从左往右的布局方向

几何化形状

键盘符号形象化几何形状,组合形式表示形状的叠加,其中最外层符号是主形状,嵌套符号是辅助形状.

  • 基本单元
表示法 含义 类型 备注
[] 矩形 节点形状 支持
() 圆角矩形 节点形状 支持
{} 菱形 节点形状 支持
<> 菱形 节点形状 不支持
-- 实线 连接线样式 支持
-. 虚线 连接线样式 支持
== 加粗实线 连接线样式 支持
=: 加粗虚线 连接线样式 不支持
> 有箭头 连接线样式 支持
- 无箭头 连接线样式 支持
双竖线 右边连接线描述文字 连接线描述文字 支持
-- 左边实线连接线描述文字 连接线描述文字 支持
-. 左边虚线连接线描述文字 连接线描述文字 支持
== 左边加粗实线连接线描述文字 连接线描述文字 支持
=: 左边加粗虚线连接线描述文字 连接线描述文字 不支持
  • 组合单元
表示法 含义 类型 备注
[[]] 正方形 节点形状 不支持
[()] 圆柱体 节点形状 支持
[{}] 棱柱体 节点形状 不支持
(()) 圆形 节点形状 支持
([]) 体育场 节点形状 支持
({}) 圆弧 节点形状 不支持
双大括号 六边形 节点形状 支持
{[]} 正多边形 节点形状 不支持
{()} 圆弧 节点形状 不支持
--> 实线带箭头 连接线样式 支持
--- 实线无箭头 连接线样式 支持
-.> 虚线带箭头 连接线样式 不支持
-.-> 虚线带箭头 连接线样式 支持
.-> 虚线带箭头 连接线样式 支持
-.- 虚线无箭头 连接线样式 支持
.- 虚线无箭头 连接线样式 支持
==> 加粗实线带箭头 连接线样式 支持
=== 加粗实线无箭头 连接线样式 支持
=:> 加粗虚线带箭头 连接线样式 不支持
=:=> 加粗虚线带箭头 连接线样式 不支持
=:= 加粗虚线无箭头 连接线样式 不支持
:= 加粗虚线无箭头 连接线样式 不支持
双竖线 右边连接线描述文字 连接线描述文字 支持
--connection line description--> 左边实线带箭头连接线描述文字 连接线描述文字 支持
-.connection line description-.-> 左边虚线带箭头连接线描述文字 连接线描述文字 支持
--connection line description--- 左边实线无箭头连接线描述文字 连接线描述文字 支持
-.connection line description-.- 左边虚线无箭头连接线描述文字 连接线描述文字 支持
==connection line description==> 左边加粗实线带箭头连接线描述文字 连接线描述文字 支持
=:connection line description=:=> 左边加粗虚线带箭头连接线描述文字 连接线描述文字 不支持
==connection line description=== 左边加粗实线无箭头连接线描述文字 连接线描述文字 支持
=:connection line description=:= 左边加粗虚线无箭头连接线描述文字 连接线描述文字 不支持

甘特图

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
gantt         
       dateFormat  YYYY-MM-DD   
       title 吴龙涛的主线任务
       excludes weekends 
       axisFormat %Y-%m-%d %a
       
       section ztest通用化
       基本功能           :done,    des1, 2022-06-20,2022-10-27
       ztest支持子命令run               :active,  des2, 2022-11-14, 7d
       修复kvmagent多环境回归bug               :active,  des2, 2022-11-14, 7d
       接入硬件环境，更加通用的devops工具(没有确定需求和任务)               :         des3, after des2, 100d
       
       section ztest对zstone支持
       需求对接梳理           :done,  2022-08-01,2022-08-12
       代码编写           :done,    2022-08-12,2022-08-23
       联调，使用标签申请环境         :done,     2022-08-23,2022-08-30
       联调，加入压缩传输           :done,     2022-08-30,2022-09-02
       联调，加入多case、环境合并、json结果输出等           :done,     2022-09-02,2022-09-14
       联调，加入dev模式，增加local和docker两种(docker镜像未完成)           :done,    2022-10-28,2022-11-03
       联调，支持原生命令           :done,    2022-11-07,2022-11-10
       
       section 重要技术支持
       浦发银行性能POC支持           :done,  2022-10-08,2022-10-18
       平安信创XSKY存储性能支持-内部环境搭建           :active,crit	,  2022-11-11,2022-11-13
       平安信创XSKY存储性能支持-内部加压验证           :active,crit	,  2022-11-11,7d
       
       section kvmagent case
       ztestlib和5个case           :done,  2022-09-14,2022-09-30
       修复一个失败的case、新增一个case(和进新代码也失败了)           :done,  2022-10-14,2022-09-30
       修复失败case           :,  2022-11-14,5d
       增加case           :,  2022-11-14,5d
       
       section 轻量标准化测试工具(竞品：路坦力的xray)
       和PM何志兵在一起确定需求以及竞品调研           :active,  d1, 2022-11-07,28d
       需求整理           : d2, after d1, 21d
       产品设计           : d3, after d2, 7d
       基本可用版本           :  after d3, 14d
       
       section ZAPT-APT
       名敏需求，加入更多log，log持久化只保留一个           :done,  2022-11-21,2022-11-23
当前任务优先级 优先级 生效时间
平安信创XSKY性能 0 全部时间
ztest 支持zstone bug fix以及新需求 0 全部时间
内部 支持 1 全部时间
ztest通用化 2 下午2点到下午6.00(仅被0优先级任务打断)，内部支持先缓一缓
kvmagent case和ztest 对kvmagent支持 2 下午2点到下午6.00(仅被0优先级任务打断)，内部支持先缓一缓
轻量标准化测试工具(竞品：路坦力的xray)调研 3 全部时间

注意事项：

  1. 留下working trace
  2. 拒绝 meaningless、 unreasonable 的需求