Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Hulk committed Jun 15, 2022
1 parent 397966c commit 008c5b3
Show file tree
Hide file tree
Showing 2 changed files with 145 additions and 45 deletions.
87 changes: 42 additions & 45 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,88 +16,85 @@
</a>
</p>

**DiDiPrism**，中文名：**小桔棱镜**，是一款专注于移动端操作行为的工具，涵盖APP`操作回放`、`操作检测`、以及`数据可视化`能力。我们在整个方案的实现过程中沉淀出了一套技术框架，希望可以逐步开源出来帮助更多人，同时也希望棱镜在大家的合力下能够更快的成长。
**中文版本**请参看[这里](README_cn.md)

**DiDiPrism** is a tool that focuses on mobile operation behavior, covering APP `Operation Playback`, `Operation Detection`, and `Data Visualization` capabilities. We have precipitated a set of technical frameworks during the implementation of the entire program, and hope that we can gradually open source it to help more people. At the same time, we also hope that Prism can grow faster with the joint efforts of everyone.

## 它有哪些亮点？
- [x] **零入侵**

业务代码无需任何适配。
## Features
- [x] **No intrusion**

- [x] **高可用**
The business code does not need any adaptation.

各项能力已在生产环境平稳运行一年以上。
- [x] **High availability**

- [x] **自研操作行为标识指令**
The capabilities have been running smoothly in the production environment for more than two years.

在支撑棱镜已有的功能外，或许可以有更大的舞台。
- [x] **Self-developed operation behavior identification instructions**

- [x] **丰富灵活的操作行为策略支持**
In addition to the existing function of supporting the Prism, there may be a larger stage.

基于DSL实现丰富的操作行为策略支持，可满足通常的检测需求。
- [x] **Rich and flexible operation behavior policy support**

- [x] **功能全面**
Based on DSL, it implements rich operation behavior policy support, which can meet the usual detection requirements.

围绕移动端操作行为全方位能力覆盖，提供更多可能。
- [x] **Full-featured**

## 用它能做什么？
### 一、操作回放（已开源）
小桔棱镜中最具创新性的功能，也是整个棱镜平台的基础，我们基于`自研的操作行为标识指令`实现了在APP端的操作回放（视频回放 / 文字回放）。相比于传统的静态埋点数据它提供了动态的操作行为，可以帮助大家更好的定位问题、优化产品，为用户创造价值。
All-round capability coverage around mobile operation behavior provides more possibilities.

当然它还可以有很多应用场景，比如**无需手写脚本的自动化测试**场景，仅单纯的操作行为标识指令就可以被应用到很多我们还没有想到但已经收到诉求的场景中，因此我们选择把它开源出来造福更多人。
## What can I do with it?
### 1. Operation Playback
The most innovative function in the DiDiPrism is also the foundation of the entire prism platform. We realize the operation playback (Video Playback / Text Playback) on the APP side based on the `self-developed operation behavior identification instruction`. Compared with the traditional static buried point data, it provides dynamic operation behavior, which can help you better locate problems, optimize products, and create value for users.

#### [Demo展示]
Of course, it can also have many application scenarios, such as **automatic testing without handwritten script** scenarios, and only simple operation behavior identification instructions can be applied to many scenarios that we have not thought of but have received demands, so we Choose to open source it to benefit more people.

#### [Demo Show]
<p align="center">
<img src="https://view.didistatic.com/static/dcms/3pwfx749nki143sb6_872x1753_compress.png" width="218" hegiht="438" alt="回放演示" />
<img src="https://view.didistatic.com/static/dcms/3pwfx749nki143sb6_872x1753_compress.png" width="218" hegiht="438" alt="Playback Show" />

<img src="https://view.didistatic.com/static/dcms/1jt5q4ncski14uosf_879x1762_compress.png" width="218" hegiht="438" alt="视频回放" />
<img src="https://view.didistatic.com/static/dcms/1jt5q4ncski14uosf_879x1762_compress.png" width="218" hegiht="438" alt="Video Playback" />

<img src="https://view.didistatic.com/static/dcms/olv82khg4ki143yz2_876x1763_compress.png" width="218" hegiht="438" alt="文字回放" />
<img src="https://view.didistatic.com/static/dcms/7qcc06d21rl4fb4os3_890x1758_compress.png" width="218" hegiht="438" alt="Text Playback" />
</p>

### 二、操作检测（已开源）
端侧实时操作行为检测功能，同样基于`自研的操作行为标识指令`以及`语义化的操作行为策略描述方案（DSL）`，支持丰富的语义和灵活的策略配置。它可以帮助我们实现端侧场景化需求，未来还希望用在客服场景中来提升用户体验，创造更多用户价值。
### 2. Operation Detection
The device-side real-time operation behavior detection function is also based on the `self-developed operation behavior identification instruction` and the `semantic operation behavior policy description scheme (DSL)`, which supports rich semantics and flexible policy configuration. It can help us realize the needs of client-side scenarios. In the future, we hope to use it in customer service scenarios to improve user experience and create more user value.

当然我们相信它也有未被发掘的应用潜力，同样开源出来集思广益。
Of course, we believe that it also has untapped application potential, and it is also open sourced to brainstorm ideas.

#### [Demo展示]
#### [Demo Show]
<p align="center">
<img src="https://view.didistatic.com/static/dcms/3pwfx5hv3ki144283_880x1763_compress.png" width="218" hegiht="438" alt="操作检测" />
</p>

### 三、数据可视化（逐步开放中..）
覆盖埋点全流程的移动端解决方案，包括埋点数据可视化范畴的`多维度PV/UV`、`热力图`、`转化率漏斗`、`页面停留时长`等功能，以及埋点辅助范畴的`测试`工具。它的意义在于改变了大家日常看数据的方式，**让原本就擅长使用数据的同学可以更便捷的用数据，让原本不擅长使用数据的同学开始喜欢用数据**。
### 3. Data Visualization (in progress.)
Mobile solutions covering the whole process of tracking, including `multi-dimensional PV/UV`, `heat map`, `conversion rate funnel`, `page dwell time` and other functions in the field of tracking data visualization, as well as the auxiliary field of tracking The `test` tool. Its significance is to change the way people look at data on a daily basis, **so that students who are good at using data can use data more conveniently, and students who are not good at using data start to like to use data**.

## 使用手册
- [iOS 代码说明文档](iOS/README.md)
- [Android 代码说明文档](Android/README.md)
- [操作行为指令 格式说明](Doc/操作行为指令/操作行为指令格式说明.md)
- [操作检测 策略配置说明](Doc/操作检测/操作检测配置文件说明.md)
## User Manual
- [iOS code documentation](iOS/README.md)
- [Android code documentation](Android/README.md)
- [Description of Self-developed operation behavior identification instruction](Doc/操作行为指令/操作行为指令格式说明.md)
- [Description of Operation detection strategy](Doc/操作检测/操作检测配置文件说明.md)

## 系列文章
- [小桔棱镜-专注移动端操作行为的利器](Doc/系列文章/小桔棱镜-专注移动端操作行为的利器.md)
- [小桔棱镜-针对移动端操作行为标识指令的探讨及棱镜最终方案介绍](Doc/系列文章/小桔棱镜-针对移动端操作行为标识指令的探讨及棱镜最终方案介绍.md)
## Series of articles
- [DiDiPrism - A powerful tool that focuses on mobile operation behavior](Doc/系列文章/小桔棱镜-专注移动端操作行为的利器.md)
- [DiDiPrism - Discussion on the mobile terminal operation behavior identification instructions and introduction of the final solution of the prism](Doc/系列文章/小桔棱镜-针对移动端操作行为标识指令的探讨及棱镜最终方案介绍.md)

## 微信交流群
由于群二维码的有效期仅为7天，故可搜索 HulkRong 加我微信入群，可备注：小桔棱镜社区用户。
## WeChat
Since the validity period of the group QR code is only 7 days, you can search for `HulkRong` and add me to WeChat to join the group, and you can remark: DiDiPrism community users.

## TODO
详见 [近期TODO](https://github.com/didi/DiDiPrism/wiki)

## 项目成员

**负责人**
[Hulk(荣浩)](https://github.com/ronghaopger)
[TODO List](https://github.com/didi/DiDiPrism/wiki)

**内部核心成员**
## Project member
[Hulk(荣浩)](https://github.com/ronghaopger)、
[梅平](https://github.com/mpmpmp3332003)、
[EastWoodYang](https://github.com/EastWoodYang)、
[张华](https://github.com/zollero)、
[戴立慧](https://github.com/blankdlh)

## 协议
## License

<img alt="Apache-2.0 license" src="https://www.apache.org/img/ASF20thAnniversary.jpg" width="128">

小桔棱镜 基于 Apache-2.0 协议进行分发和使用，更多信息参见 [协议文件](LICENSE)。
DiDiPrism is published under the Apache-2.0 license，For details check out the [LICENSE.TXT](LICENSE)。
103 changes: 103 additions & 0 deletions README_cn.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<p align="center">
<img src="https://view.didistatic.com/static/dcms/1jt5q12q9lkgrtelg2_180x180.png" alt="小桔棱镜" title="小桔棱镜" width="180"/>
</p>

<p align="center">
<a href="https://github.com/didichuxing/DiDiPrism/blob/master/LICENSE">
<img src="https://img.shields.io/badge/license-Apache-blue.svg" />
</a>

<a href="">
<img src="https://img.shields.io/badge/platform-ios%20%7C%20android-lightgray.svg" />
</a>

<a href="">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
</a>
</p>

**DiDiPrism**，中文名：**小桔棱镜**，是一款专注于移动端操作行为的工具，涵盖APP`操作回放`、`操作检测`、以及`数据可视化`能力。我们在整个方案的实现过程中沉淀出了一套技术框架，希望可以逐步开源出来帮助更多人，同时也希望棱镜在大家的合力下能够更快的成长。


## 它有哪些亮点？
- [x] **零入侵**

业务代码无需任何适配。

- [x] **高可用**

各项能力已在生产环境平稳运行两年以上。

- [x] **自研操作行为标识指令**

在支撑棱镜已有的功能外，或许可以有更大的舞台。

- [x] **丰富灵活的操作行为策略支持**

基于DSL实现丰富的操作行为策略支持，可满足通常的检测需求。

- [x] **功能全面**

围绕移动端操作行为全方位能力覆盖，提供更多可能。

## 用它能做什么？
### 一、操作回放（已开源）
小桔棱镜中最具创新性的功能，也是整个棱镜平台的基础，我们基于`自研的操作行为标识指令`实现了在APP端的操作回放（视频回放 / 文字回放）。相比于传统的静态埋点数据它提供了动态的操作行为，可以帮助大家更好的定位问题、优化产品，为用户创造价值。

当然它还可以有很多应用场景，比如**无需手写脚本的自动化测试**场景，仅单纯的操作行为标识指令就可以被应用到很多我们还没有想到但已经收到诉求的场景中，因此我们选择把它开源出来造福更多人。

#### [Demo展示]
<p align="center">
<img src="https://view.didistatic.com/static/dcms/3pwfx749nki143sb6_872x1753_compress.png" width="218" hegiht="438" alt="回放演示" />

<img src="https://view.didistatic.com/static/dcms/1jt5q4ncski14uosf_879x1762_compress.png" width="218" hegiht="438" alt="视频回放" />

<img src="https://view.didistatic.com/static/dcms/7qcc06d21rl4fb4os3_890x1758_compress.png" width="218" hegiht="438" alt="文字回放" />
</p>

### 二、操作检测（已开源）
端侧实时操作行为检测功能，同样基于`自研的操作行为标识指令`以及`语义化的操作行为策略描述方案（DSL）`，支持丰富的语义和灵活的策略配置。它可以帮助我们实现端侧场景化需求，未来还希望用在客服场景中来提升用户体验，创造更多用户价值。

当然我们相信它也有未被发掘的应用潜力，同样开源出来集思广益。

#### [Demo展示]
<p align="center">
<img src="https://view.didistatic.com/static/dcms/3pwfx5hv3ki144283_880x1763_compress.png" width="218" hegiht="438" alt="操作检测" />
</p>

### 三、数据可视化（逐步开放中..）
覆盖埋点全流程的移动端解决方案，包括埋点数据可视化范畴的`多维度PV/UV`、`热力图`、`转化率漏斗`、`页面停留时长`等功能，以及埋点辅助范畴的`测试`工具。它的意义在于改变了大家日常看数据的方式，**让原本就擅长使用数据的同学可以更便捷的用数据，让原本不擅长使用数据的同学开始喜欢用数据**。

## 使用手册
- [iOS 代码说明文档](iOS/README.md)
- [Android 代码说明文档](Android/README.md)
- [操作行为指令 格式说明](Doc/操作行为指令/操作行为指令格式说明.md)
- [操作检测 策略配置说明](Doc/操作检测/操作检测配置文件说明.md)

## 系列文章
- [小桔棱镜-专注移动端操作行为的利器](Doc/系列文章/小桔棱镜-专注移动端操作行为的利器.md)
- [小桔棱镜-针对移动端操作行为标识指令的探讨及棱镜最终方案介绍](Doc/系列文章/小桔棱镜-针对移动端操作行为标识指令的探讨及棱镜最终方案介绍.md)

## 微信交流群
由于群二维码的有效期仅为7天，故可搜索 HulkRong 加我微信入群，可备注：小桔棱镜社区用户。

## TODO
详见 [近期TODO](https://github.com/didi/DiDiPrism/wiki)

## 项目成员

**负责人**
[Hulk(荣浩)](https://github.com/ronghaopger)

**内部核心成员**
[Hulk(荣浩)](https://github.com/ronghaopger)、
[梅平](https://github.com/mpmpmp3332003)、
[EastWoodYang](https://github.com/EastWoodYang)、
[张华](https://github.com/zollero)、
[戴立慧](https://github.com/blankdlh)

## 协议

<img alt="Apache-2.0 license" src="https://www.apache.org/img/ASF20thAnniversary.jpg" width="128">

小桔棱镜 基于 Apache-2.0 协议进行分发和使用，更多信息参见 [协议文件](LICENSE)。

0 comments on commit 008c5b3

Please sign in to comment.