利用统计代码对Web用户手册进行数据分析

用户手册要有足够的反馈才能更好地改进，直接去问最终用户的感受当然是最好了，不过这不太现实，因为一般情况下技术文档工程师很少有机会频繁、近距离地接触到最终用户。好消息是，如果你的用户手册是以Web方式呈现的，那么你还有其他可选的解决方案。

有建站经验的人都知道，通过部署第三方提供的统计代码可以有效地收集和分析网站访问数据，以便对网站的内容或者布局做出进一步的优化处理。这类统计服务以Google Analytics最为出名，国内也有不少同类工具，如百度统计。能够收集到的用户数据是很丰富的，如用户经常访问哪些网页，用户使用的操作系统和浏览器类型等等。如果你用网页的形式输出用户手册，也可以考虑使用统计代码来采集用户行为数据。

对于熟悉HTML的人来说，直接在网页上嵌入统计代码应该不是件难事。如果不熟悉HTML的话，选择一些比较容易支持统计代码的现有文档工具，可操作性会更强一些。就我的实际经验而言，面对中小规模的技术文档写作任务，reStructuredText Sphinx是个不错的选择，关键是Sphinx默认就提供了统计代码嵌入功能，非常方便，这里简单介绍一下。

在默认的_templates文件下创建一个layout.html文件，内容参考如下：

{% extends “!layout.html” %}

{%- block extrahead %}
{{ super() }}
<script type=”text/javascript”>
var _gaq = _gaq || [];
_gaq.push([‘_setAccount’, ‘XXX account number XXX’]);
_gaq.push([‘_trackPageview’]);
</script>
{% endblock %}

{% block footer %}
{{ super() }}
<div>This page uses <a href=”http://analytics.google.com/”>
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type=”text/javascript”>
(function() {
var ga = document.createElement(‘script’);
ga.src = (‘https:’ == document.location.protocol ?
‘https://ssl’ : ‘http://www’) + ‘.google-analytics.com/ga.js’;
ga.setAttribute(‘async’, ‘true’);
document.documentElement.firstChild.appendChild(ga);
})();
</script>
</div>
{% endblock %}

把上面这段代码中的XXX account number XXX替换成你的Google Analytics对应统计ID即可。Sphinx官网手册的这个功能介绍是以GA为例的，实际上，我还自行添加了百度统计代码（将异步代码放到第一个</script>
后即可），经测试，这么做也是可行的。为保障用户的知情权，上面这段代码默认会在所有生成的HTML页面底部加上一句话：This page uses Google Analytics to collect statistics. You can disable it by blocking the JavaScript coming from www.google-analytics.com。根据实际需要，这句话当然也是可以自行修改的。

早期，我并没有在自己的博客上部署统计代码，因为怕拖慢网页加载速度。Google Analytics是国外的服务，在访问速度上没有优势，而国内的类似服务呢，我又不太信得过，你懂的……后来试着部署了GA，发现对博客的速度影响其实不算大。前几个月发现百度统计已经相当成熟了，也试了一下，发现效果不错，有些功能还挺有意思的，如热力图（查看用户点击某个页面区域的热度）、IP统计（GA无法统计到IP）、访客属性（性别比例、年龄分布等）。

回到本文主题上来，实际上，对用户手册的使用进行数据分析，不仅仅对改进手册本身有帮助，对产品本身的改进也是帮助的。举个简单的例子，前面提过，统计代码可以收集到用户使用哪种类型的浏览器。如果你的产品是基于Web的（常见的说法是B/S），那么你必然要关注浏览器兼容性的问题。通过分析收集到的用户数据，你可以把测试重点放在用户最常用的浏览器类型上。

需要说明的是，收集用户数据会涉及到隐私权的问题。因此，除了必要的声明外（如在页面底部加以说明），本文介绍的方法更适合公开发布的Web网页（有些公司会在官网直接公布产品使用手册），而不是用于卖给客户的最终产品。