Skip to content

Commit 6857266

Browse files
authored
fix: fix docs markdown bold syntax conflicts (#187)
1 parent 478e0d4 commit 6857266

File tree

10 files changed

+48
-45
lines changed

10 files changed

+48
-45
lines changed

docs/specification/graph/conDashboard.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,23 @@ order: 4
2121

2222
业务总览页展现关键指标数目列表、报警分布,事件列表,帮助用户快速定位到问题模块,进入故障排查。
2323

24-
**如何使用:**总指标卡描述了所监控业务的应用总个数、出现异常的应用数,以及自定义大盘个数,用于把控监控范围;报警分布展现各时段下异常数量,便于快速聚焦到需要关注的时间段里;事件列表提供故障处理人与处理进度等信息,方便管理者进行监管。
24+
**如何使用:** 总指标卡描述了所监控业务的应用总个数、出现异常的应用数,以及自定义大盘个数,用于把控监控范围;报警分布展现各时段下异常数量,便于快速聚焦到需要关注的时间段里;事件列表提供故障处理人与处理进度等信息,方便管理者进行监管。
2525

2626
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*o8qDTrJVX_8AAAAAAAAAAAAAARQnAQ)
2727

2828
### 2.故障排查页
2929

3030
故障排查页包含秒级时间区块筛选器、故障事件列表、故障事件基本信息、故障定位细分、失败任务链路、事件列表。
3131

32-
**如何使用:**全局秒级时间区块筛选器对时间进行线性呈现,并将有故障的时间点高亮,有利于用户基于时间高效筛选排查问题高发区。下方左侧以列表形式罗列故障事件可供切换;右侧以总-分形式呈现事件波动概述、故障处理进度、故障定位细分、失败业务流程链路,设计师可根据业务需求选取合适的区块进行。另外,本页还可以延伸添加趋势图等其他图表类型。
32+
**如何使用:** 全局秒级时间区块筛选器对时间进行线性呈现,并将有故障的时间点高亮,有利于用户基于时间高效筛选排查问题高发区。下方左侧以列表形式罗列故障事件可供切换;右侧以总-分形式呈现事件波动概述、故障处理进度、故障定位细分、失败业务流程链路,设计师可根据业务需求选取合适的区块进行。另外,本页还可以延伸添加趋势图等其他图表类型。
3333

3434
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*f1qgSYqWaoIAAAAAAAAAAAAAARQnAQ)
3535

3636
### 3.自定义大盘页
3737

3838
自定义大盘为用户自主搭建的图表大盘页,可以包含智能决策意见列表/总指标卡、全局筛选与布局切换、自定义图表。
3939

40-
**如何使用:**本页平铺所有指标,呈现全量信息。顶部列表展现智能决策建议,或监控总指标概览(如“齐全度”指标卡),下方工具栏包含全局筛选器、数据更新选项和图表排列方式。图表以单列的列表式或多列平铺卡片的形式切换展现。所有图表支持 y 轴缩放控制,以规避监控场景中易出现的极值问题。
40+
**如何使用:** 本页平铺所有指标,呈现全量信息。顶部列表展现智能决策建议,或监控总指标概览(如“齐全度”指标卡),下方工具栏包含全局筛选器、数据更新选项和图表排列方式。图表以单列的列表式或多列平铺卡片的形式切换展现。所有图表支持 y 轴缩放控制,以规避监控场景中易出现的极值问题。
4141

4242
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*c2XnTKBLUzkAAAAAAAAAAAAAARQnAQ)
4343

@@ -51,7 +51,7 @@ order: 4
5151

5252
点击图表/文字链/热区,触发抽屉查看下钻信息和明细列表;在抽屉中下钻,可推出二级抽屉,用于呈现包含更细节信息的图表。
5353

54-
**如何使用:**需要对主页面上的信息进行下钻探索交互时,可使用抽屉,快速便捷。
54+
**如何使用:** 需要对主页面上的信息进行下钻探索交互时,可使用抽屉,快速便捷。
5555

5656
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*WOlVRbB0BdQAAAAAAAAAAAAAARQnAQ)
5757

docs/specification/graph/map.zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ order: 2
6161

6262
### 线图层数据
6363

64-
**两点连线:**点的移动形成了线,线的位置参数中需至少包含起点、终点的经纬度信息。比如发货地与收货地。
64+
**两点连线:** 点的移动形成了线,线的位置参数中需至少包含起点、终点的经纬度信息。比如发货地与收货地。
6565

6666
| 起点 | 终点 | 起点-经度 | 起点-纬度 | 终点-经度 | 终点-纬度 | 来往次数 |
6767
| ---- | ---- | ---------- | --------- | ---------- | --------- | -------- |
6868
| A1 | A2 | 116.490794 | 39.949238 | 116.490794 | 39.949238 | 280 |
6969
| ... | | | | | | |
7070

71-
**寻路路径:**两点之间应用寻路规则形成运动路径。数据结构上是多个连续的经纬度打点。
71+
**寻路路径:** 两点之间应用寻路规则形成运动路径。数据结构上是多个连续的经纬度打点。
7272

7373
| 经纬度 | 气温(摄氏度) |
7474
| --- | --- |

docs/specification/graph/mobile.zh.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@ AntV 拥有一套基于移动端的可视化图形语法图表库(F2),我
2020

2121
基于以上移动端的特性,结合 AntV 可视化设计原则,建议在产品中进行数据可视化设计时,遵循以下几点建议:
2222

23-
## **1、信息轻量聚焦**
23+
## 1、信息轻量聚焦
2424

25-
**聚焦当前场景用户任务,避免不必要的视觉元素干扰**移动端可视化信息传递需要更加聚焦用户在场景中的任务和具体的信息,最大程度刨除图表展示中的无用或相对次要的信息及图形元素,**减少信息维度交叉的复杂性和视觉干扰**,巧妙采用流程、排版、动效的方式将信息拆解。
25+
**聚焦当前场景用户任务,避免不必要的视觉元素干扰**移动端可视化信息传递需要更加聚焦用户在场景中的任务和具体的信息,最大程度刨除图表展示中的无用或相对次要的信息及图形元素,**减少信息维度交叉的复杂性和视觉干扰**,巧妙采用流程、排版、动效的方式将信息拆解。
2626

2727
| PC | 移动端 |
2828
| --- | --- |
2929
| <img src="https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*GT9kSaph_38AAAAAAAAAAAAAARQnAQ" width="500pt" height="500pt"> | <img src="https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*UMuASYgxoJAAAAAAAAAAAAAAARQnAQ" width="500pt"> |
3030
| |
3131

32-
## **2、手势操作自然**
32+
## 2、手势操作自然
3333

3434
移动端的硬件特质以及发展趋势,要求可视化的操作更符合人的自然行为反应,使交互操作更自然。手势方式的选择上应该源于生活经验,易于理解,学习成本低,用户无操作压力。
3535

36-
区别于游戏和其他沉浸式应用中的手势选择,在可视化场景中,**应该尽量避免高学习成本的手势,同时需要注意保持页面间交互的一致性**以下为 AntV 的设计师推荐使用的最常用的标准手势:
36+
区别于游戏和其他沉浸式应用中的手势选择,在可视化场景中,**应该尽量避免高学习成本的手势,同时需要注意保持页面间交互的一致性**以下为 AntV 的设计师推荐使用的最常用的标准手势:
3737

3838
![](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*SmlZQY1NH-8AAAAAAAAAAAAAARQnAQ)
3939

@@ -47,7 +47,7 @@ AntV 拥有一套基于移动端的可视化图形语法图表库(F2),我
4747
| 缩放 | 探索、识别数据 | Pinch ![](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*wE0sT7UUeesAAAAAAAAAAAAAARQnAQ) | ![](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*KKKGRKluIg4AAAAAAAAAAAAAARQnAQ) |
4848
| 平移 | 探索更大的数据空间 | Swipe ![](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*ELAJS7z5iLkAAAAAAAAAAAAAARQnAQ) | ![](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*yWrQQ5aLj6UAAAAAAAAAAAAAARQnAQ) |
4949

50-
## 3**、功能组件完善易用**
50+
## 3、功能组件完善易用
5151

5252
由于硬件显示屏的限制,传统 PC 上的图表在展示上并不能很好的在移动端上做适应,因此对于某些功能组件,需要针对移动端做更具针对性的设计(以下拿 tooltip 为例)。由于硬件显示屏的限制,传统 PC 上的图表在展示上并不能很好的在移动端上做适应,因此对于某些功能组件,需要针对移动端做更具针对性的设计(以下拿 tooltip 为例)。
5353

@@ -82,7 +82,7 @@ AntV 拥有一套基于移动端的可视化图形语法图表库(F2),我
8282

8383
由于用户的某些细节阅读和深度分析的需要,需要对图表的展示形态做变化,使得用户更容易看到细节,或有利于用户的进一步的操作。主要包括:
8484

85-
#### **场景切换和纵向的适配**
85+
#### 场景切换和纵向的适配
8686

8787
在不同页面中相同图表可能承载的用户诉求类型不相同,需要通过不同场景的切换和变化,来更好的满足并达到较好的用户体验。
8888

docs/specification/graph/pubDashboard.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ order: 3
3939

4040
**有逻辑组织页面层次**,Shneiderman 于 1996 年提出可视化信息检索的箴言 Overview First, Zoom and Filter, Then Details-on-De-mand,译为“概览第一,聚焦过滤,再按需查看详情”。它符合人类寻求信息的基本逻辑:先大体,再局部,然后聚焦兴趣点进行探索,这是一个由表及里的过程。
4141

42-
**合理排布内容**人的阅读顺序为从左至右,从上而下,采用格式塔设计原理,有限组织不同方面的思路,便于分组和快速扫描。将最重要的视图、最关键的指标放在此类型页面的顶部或左上方。阅读者可以快速准确地找到他们需要查看的文字。当我们打开网页或者仪表盘的时候,第一眼会看哪里?最可能是左手边,可将关键信息放在此位置。
42+
**合理排布内容**人的阅读顺序为从左至右,从上而下,采用格式塔设计原理,有限组织不同方面的思路,便于分组和快速扫描。将最重要的视图、最关键的指标放在此类型页面的顶部或左上方。阅读者可以快速准确地找到他们需要查看的文字。当我们打开网页或者仪表盘的时候,第一眼会看哪里?最可能是左手边,可将关键信息放在此位置。
4343

44-
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*skq8RayrxeYAAAAAAAAAAAAAARQnAQ)\*\*
44+
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*skq8RayrxeYAAAAAAAAAAAAAARQnAQ)
4545

46-
\*\*内容组织 Tips
46+
内容组织 Tips
4747

4848
- 明确此类页面的使用者身份,以及分析目的,从而选择对应的页面类型.   划分用户。不同业务线间,关注的核心指标不同,常见的指标类型有:宏观的大盘数据,具体的业务指标。
4949
- 针对决策者,可以选择描述型的指标结果页面;
@@ -57,7 +57,7 @@ order: 3
5757

5858
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*h-e0RbW-4nwAAAAAAAAAAAAAARQnAQ)
5959

60-
**多用对比:**在数据分析领域,经常会说“无对比不分析”。没有对比就没有伤害,没有对比就看不出差距。所以,多用对比,方便阅读读看出数据之间的差异。比如当前数据与目标对比、同期对比往期。
60+
**多用对比:** 在数据分析领域,经常会说“无对比不分析”。没有对比就没有伤害,没有对比就看不出差距。所以,多用对比,方便阅读读看出数据之间的差异。比如当前数据与目标对比、同期对比往期。
6161

6262
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*N5-ORpGpdUkAAAAAAAAAAAAAARQnAQ)
6363

docs/specification/language/basic.zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ AntV 的设计体系中,视觉设计尤为重要。本文主要包括 3 个篇
4141

4242
在数据可视化领域中,数据与颜色的映射是非常重要的一个环节。颜色有三个视觉通道,分别是色调(H)、饱和度(S)、明度(B),不同的视觉通道可以与不同的数据类型建议关联。
4343

44-
**色调(H):**通常使用颜色中的不同色调来描述不同的分类数据,如水果品类中苹果映射为红色、香蕉映射为黄色、梨映射为绿色,将品类与色调(H)建立了关联。
44+
**色调(H):** 通常使用颜色中的不同色调来描述不同的分类数据,如水果品类中苹果映射为红色、香蕉映射为黄色、梨映射为绿色,将品类与色调(H)建立了关联。
4545

46-
**饱和度(S)/明度(B):**颜色通过明暗和饱和度的共同变化来描述有序或数值型的连续数据,比如身高由低到高或由 160cm 到 180 cm 的颜色映射为由浅到深,将连续变化与颜色的明暗饱和变化建立关联。
46+
**饱和度(S)/明度(B):** 颜色通过明暗和饱和度的共同变化来描述有序或数值型的连续数据,比如身高由低到高或由 160cm 到 180 cm 的颜色映射为由浅到深,将连续变化与颜色的明暗饱和变化建立关联。
4747

4848
| 颜色属性 | | 关系 | 数据类型 | |
4949
| :-: | :-: | :-: | --- | --- |
@@ -53,7 +53,7 @@ AntV 的设计体系中,视觉设计尤为重要。本文主要包括 3 个篇
5353

5454
### 6 大色板类型
5555

56-
AntV 色板以蚂蚁极客蓝为起始主色,根据不同数据类型、使用场景扩展出 6 种可视化色板类型,可完美兼容 Ant Design  UI 资产。以下所有色板均通过无障碍测试校验,可放心使用。
56+
AntV 色板以蚂蚁极客蓝为起始主色,根据不同数据类型、使用场景扩展出 6 种可视化色板类型,可完美兼容 Ant Design UI 资产。以下所有色板均通过无障碍测试校验,可放心使用。
5757

5858
![02-AntV 品牌色@3x.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*ob0rTbJccqgAAAAAAAAAAAAAARQnAQ)
5959

docs/specification/language/interact.zh.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Shneiderman [1] 提出了经典的可视化信息交互策略:概览、缩放
1111

1212
经过业务的实践和沉淀,AntV 从用户视角出发,按照用户的目标和行为对可视化交互进行梳理。我们发现用户在进行可视化数据分析时,通常会经历三个步骤,分别为「看数-分析-洞察」。
1313

14-
**看数:** 主要指用户获取数据并初步可视化加工和阅读查看的行为**分析:** 主要指用户对数据进行调整,从更多角度进行看数的行为。 **洞察:** 主要指用户通过交互强化洞见,并对结果进行流转的行为。
14+
**看数:** 主要指用户获取数据并初步可v视化加工和阅读查看的行为**分析:** 主要指用户对数据进行调整,从更多角度进行看数的行为。 **洞察:** 主要指用户通过交互强化洞见,并对结果进行流转的行为。
1515

1616
基于更多的业务调研和桌面调研,我们总结出常见的 24 类可视化交互,这是我们从用户视角出发的最全归纳。
1717

@@ -189,4 +189,9 @@ AntV 5.0 的设计价目标是让用户更有信任感、轻松感和意义感
189189

190190
## 参考文献
191191

192-
[1] Schneiderman B. The eyes have it: a task by data type taxonomy forinformation\visualizations[J]. Craft of Information Visualization, 1996:364-371. [2] Dix, Alan, Ellis, Geoffrey. Starting simple: adding value to static visualisation throughsimple interaction[J]. 1998. [3]李洪海,齐兵.界面设计中交互行为的分类[J].艺术与设计:理论,2013(11):119-121. [4]Landesberger T V, Fiebig S, Bremm S, et al. Interaction Taxonomy for Tracking of UserActions in Visual Analytics Applications[J]. 2014:653-670. [5] Gotz D, Zhou M X. Characterizing users' visual analytic activity for insightprovenance[C]// IEEE Symposium on Visual Analytics Science & Technology. 2008. [6]:Donald A.Norman.《设计心理学 1》[M]
192+
[1] Schneiderman B. The eyes have it: a task by data type taxonomy forinformation\visualizations[J]. Craft of Information Visualization, 1996:364-371.
193+
[2] Dix, Alan, Ellis, Geoffrey. Starting simple: adding value to static visualisation throughsimple interaction[J]. 1998.
194+
[3]李洪海,齐兵.界面设计中交互行为的分类[J].艺术与设计:理论,2013(11):119-121.
195+
[4] Landesberger T V, Fiebig S, Bremm S, et al. Interaction Taxonomy for Tracking of UserActions in Visual Analytics Applications[J]. 2014:653-670.
196+
[5] Gotz D, Zhou M X. Characterizing users' visual analytic activity for insightprovenance[C]// IEEE Symposium on Visual Analytics Science & Technology. 2008.
197+
[6] Donald A.Norman.《设计心理学 1》[M]

docs/specification/language/media.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ order: 3
2121

2222
### 信息响应原则
2323

24-
- **宏观:**保证核心信息优先展示,体现数据主要特征。
24+
- **宏观:** 保证核心信息优先展示,体现数据主要特征。
2525

2626
折线图展现趋势和变化,柱形图展现排名和分布,饼图展示占比。
2727

28-
- **微观:**空间有限时,体现主要信息,保留图形特征。
28+
- **微观:** 空间有限时,体现主要信息,保留图形特征。
2929

3030
所有尺寸下细节信息都能通过交互获取到。
3131

@@ -66,9 +66,9 @@ order: 3
6666

6767
### 4. 明确约束条件
6868

69-
**外部约束:**包含屏幕尺寸和设备属性。前者可拆解出断点范围,后者进一步约束了交互状态。
69+
**外部约束:** 包含屏幕尺寸和设备属性。前者可拆解出断点范围,后者进一步约束了交互状态。
7070

71-
**内部约束:**包含组件所在的大小,组件内元素个数和间距。
71+
**内部约束:** 包含组件所在的大小,组件内元素个数和间距。
7272

7373
![image.png](https://gw.alipayobjects.com/mdn/rms_a8a5bf/afts/img/A*CdDuRpbruiUAAAAAAAAAAAAAARQnAQ)
7474

docs/specification/module/timeBar.zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ order: 5
7777

7878
播放方式,分两种:
7979

80-
- **累计时间段数据**开始时间不变,结束时间持续增加,适合查看从一个时间点开始,持续观察累计变化趋势;
81-
- **区间时间段数据**开始到结束时间的区间段固定不变,播放时该时间段水平移动,适合查看固定时间段内的数据变化趋势;
80+
- **累计时间段数据**开始时间不变,结束时间持续增加,适合查看从一个时间点开始,持续观察累计变化趋势;
81+
- **区间时间段数据**开始到结束时间的区间段固定不变,播放时该时间段水平移动,适合查看固定时间段内的数据变化趋势;
8282

8383
### 时间配置
8484

docs/specification/module/titleNote.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ order: 0
1515

1616
## 内容和位置
1717

18-
**标题内容**言简意赅,尽量避免被截断;
18+
**标题内容**言简意赅,尽量避免被截断;
1919

20-
**标题位置**正、副标题一般放置于卡片左上角,标题宽度不超过卡片宽度。
20+
**标题位置**正、副标题一般放置于卡片左上角,标题宽度不超过卡片宽度。
2121

22-
**注释内容**引用内容、数据来源等,保证正确性;
22+
**注释内容**引用内容、数据来源等,保证正确性;
2323

24-
**注释位置**一般放置于卡片左下角
24+
**注释位置**一般放置于卡片左下角
2525

2626
## 常见问题
2727

0 commit comments

Comments
 (0)