埋点文档：指导埋点准确实施的关键文档该如何撰写？

作者：NK冬至

来源：首席数据科学家

上次分享的《数据埋点基础：如何将行为标准化》文章，受到了很多朋友的关注。今天就在上次文章的基础上，分享一下埋点文档的设计。

01

—

关于文档的类型

其实埋点文档，有点类似于产品的PRD文档，是用于指导研发进行准确的埋点实施的。因此，并没有说一种固定的模板可供所有的公司、场景使用。要根据自己的习惯、具体的场景来。但总体还是有一些通用的内容。

首先，埋点文档一般有哪几种类型呢？

总结下来，通常有两类：一类是基于功能模块的，一类是基于事件类型的。相当于两种不同的索引吧。

（1）基于事件类型的埋点文档

直接给个截图吧（也是公众号后台分享的内容）：

这里的索引，是事件。

每个事件的名称、属性、属性值都有详细描述。另外，在【备注】中，有描述事件的触发时机，即什么时候触发事件。当然，也可以将【触发时机】作为单独的一列进行呈现。

另外，经常有同一个事件有多个不同地方发生的情况。比如，首页浏览、商详页浏览等等，其实都是【浏览事件】，只不过是不同的页面，这时候，可以将【首页浏览】、【商详页浏览】两个事件，提炼成一个时间【浏览事件】，然后将页面名称作为一个参数，置于【浏览事件】的属性中，用以区分是哪个页面。这样提炼后的事件，更加简练、概况。

分享给大家的文档，就是以事件类型为主的埋点文档。大家可以参考一下这里的事件的设计及参数的处理。

（2）基于功能模块的埋点文档

除了基于事件的埋点文档，还有一种比较常见的，就是基于功能模块的埋点文档。

基于事件的文档，比较干练、系统。但有个问题就是，如果有新的页面、新的功能上线，想要加埋点，往往在事件类型的埋点文档中不容易维护。长此以往，文档的质量不容易保障。而以功能模块为主的文档，比较容易维护。

当然，以功能模块为主的文档，依然需要事件、事件属性、触发时机等基本内容。只不过是，会显得比较冗余，因为不同的页面经常采集的事件都有很多雷同的。比如浏览事件、点击事件等，每个页面基本都会涉及。

02

—

示例文档

这里的示例文档，包括了4个sheet：

主要包括【简述】、【事件表】、【用户表】、【预置属性】。关于【预置属性】，在《数据埋点基础：如何将行为标准化》中有介绍过，这里就不再赘述了。（算了，还是提一下吧，预置属性就是比较通用的属性，比如浏览器、用户ID、版本等等。这样就不需要在每份事件的属性中枚举了）

这份示例文档中，还单独拿出了【用户表】，是采集的用户相关的内容，便于后续进行用户相关的分析。这块内容可以根据自己的需求，灵活处理。因为通常来讲，公司都会自己维护一份用户相关的表，专门再维护一份采集的用户信息表，意义不是很大。

关于埋点文档的设计，今天就分享这些，欢迎大家继续关注！