Skip to content

Commit

Permalink
update ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
Hulk committed Nov 30, 2020
1 parent c545fc8 commit 92f9daa
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 21 deletions.
10 changes: 5 additions & 5 deletions Android/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 小桔棱镜 Android SDK

* prism-monitor模块负责收集用户操作行为
* prism-playback模块负责用户操作行为回放
* prism-behavior模块负责用户操作行为检测
* prism-monitor模块负责采集操作行为
* prism-playback模块负责操作行为回放
* prism-behavior模块负责操作行为检测

## prism-monitor使用说明

Expand All @@ -26,7 +26,7 @@ PrismMonitor.getInstance().addOnPrismMonitorListener(new PrismMonitor.OnPrismMon
// 在Application创建时期初始化
PrismPlayback.getInstance().init(this);
//通过PrismMonitor监听获取数据
//通过PrismMonitor监听采集操作数据
List<EventData> mPlaybackEvents = ...;
//开启回放
PrismPlayback.getInstance().playback(mPlaybackEvents);
Expand All @@ -39,7 +39,7 @@ PrismPlayback.getInstance().playback(mPlaybackEvents);
PrismBehavior.getInstance().init(this);
// 设置行为规则
// 当用户操作符合某行为规则的时候,会发送action为prism_behavior_detect_rule_hit的广播。
// 当操作行为符合某行为规则的时候,会发送action为prism_behavior_detect_rule_hit的广播。
PrismBehavior.getInstance().setRules(...);
// 开启检测
PrismBehavior.getInstance().start();
Expand Down
6 changes: 3 additions & 3 deletions Doc/操作检测/操作检测配置文件说明.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,13 +133,13 @@ if 不包含历史行为
* 0: 不参考
* 1: 参考

## 6、行为指令描述
### 行为指令
## 6、操作行为指令描述
### 操作行为指令
字段名:instruction

字段类型:数组 (指令匹配时,数组元素之间默认为“或”的关系,意在兼容可能的新老版本指令)

详见:[行为指令格式说明](/Doc/行为指令/行为指令格式说明.md)
详见:[操作行为指令格式说明](/Doc/操作行为指令/操作行为指令格式说明.md)

### 行为指令参数
字段名:itemName
Expand Down
5 changes: 0 additions & 5 deletions Doc/系列文章/小桔棱镜-移动端操作行为利器.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# 一、棱镜是什么
小桔棱镜是一款专注于移动端操作行为的工具,从最初的埋点数据可视化,到操作回放、操作检测,不断尝试围绕APP操作行为发挥技术价值。本篇我们会从产品设计理念和技术实现思路上对棱镜进行整体介绍。

### 功能结构图
![](https://view.didistatic.com/static/dcms/1jt5q5bqvkesdosxf_1114x435.png)

- - - -

# 二、棱镜都有哪些能力
Expand Down Expand Up @@ -64,8 +61,6 @@

因此当时有一股冲动就是要让大家也能容易的看到这些问题,给大家一个拥有上帝视角理解用户的能力,再结合灵活的筛选方式,帮助大家去**发现那些隐蔽而又迫切的用户问题**

<img src="https://view.didistatic.com/static/dcms/3pwfx1lms3kepi2viv_1242x2208_compress.jpeg" width="272" hegiht="480" align=center />

## 2.2 回放如何做?
有了冲动,可实际情况是在我的脑海里从来没有过类似的实践经验,所以就全靠想象起步了。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,20 +130,20 @@ Xcode提供的UITest框架是允许用户录制操作流程的,详见[我之
* 如果是UITableView,取cell的indexPath。
* 如果是UICollectionView,取cell的indexPath。

这个思路目前是为了完美实现行为回放设计的,但是太区分列表中的item,不利于行为检测或者稳定性
这个思路目前是为了完美实现操作回放设计的,但是太区分列表中的item,不利于操作检测或者稳定性

- - - -
**又一道分隔线**
- - - -

# 八、最终经过反复实践后的棱镜方案
## 1、设计驱动迭代,迭代反馈设计
最初在设计这套方案的时候,就是为了实现`自动埋点``行为回放``行为检测`这些技术构想,我们称之为**设计驱动迭代**
最初在设计这套方案的时候,就是为了实现`自动埋点``操作回放``操作检测`这些技术构想,我们称之为**设计驱动迭代**

而在真正实践的过程中,又遇到了很多很多问题,我们结合问题和需求场景,再次反复推敲验证,最终产出了**系统性的行为标识指令方案**,可以用一个很直观的公式展示:
而在真正实践的过程中,又遇到了很多很多问题,我们结合问题和需求场景,再次反复推敲验证,最终产出了**系统性的操作行为标识指令方案**,可以用一个很直观的公式展示:

```
行为标识 = 动作信息(vm) + 响应链信息(vp) + 列表信息(vl) + 区位信息(vq) + 参考信息(vr) + 功能信息(vf)
操作行为标识 = 动作信息(vm) + 响应链信息(vp) + 列表信息(vl) + 区位信息(vq) + 参考信息(vr) + 功能信息(vf)
```

公式中的每个因子都是在反复思考实践后确定的,详细思路可以关注我们的开源代码。
Expand Down
8 changes: 4 additions & 4 deletions iOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ pod 'DiDiPrism'

## 代码目录说明
- Ability (功能区)
- BehaviorDetect (行为检测模块
- BehaviorReplay (行为回放模块
- BehaviorDetect (操作检测模块
- BehaviorReplay (操作回放模块
- Category (分类区)
- Core (核心区)
- Instruction (指令模块,含指令定义、生成、解析等)
- Intercept (拦截模块,含触控拦截、请求拦截、事件监听等)
- Util (工具区)

## 代码使用说明
### 行为回放
### 操作回放
```
// No.1 监听NSNotification获取操作行为指令,构造 PrismBehaviorListModel 实例。
// name: @"prism_new_instruction_notification" , userInfo: @{@"instruction": @"指令内容", @"params": @"参数"}
Expand All @@ -25,7 +25,7 @@ pod 'DiDiPrism'
// No.2-2 通过 PrismBehaviorListModel 实例的 instructionTextArray 属性获取文字回放的具体内容。
```

### 行为检测
### 操作检测
```
// No.1 通过 PrismBehaviorDetectManager 单例的 setupWithConfigModel: 方法加载策略配置,进入检测模式。
Expand Down

0 comments on commit 92f9daa

Please sign in to comment.