文档与知识库

这个分类涵盖什么

把事情写下来、让别人能找到的地方：面向客户的帮助中心、内部手册、开发者文档，以及让这一切有用的搜索。

关键的区别在于受众。面向客户的文档需要公开地址、评审流程，以及写给已经卡住的人看的语言。面向员工的文档可以杂乱一些，需要的是权限。

个人和小团队的知识属于笔记与Wiki。未被回答的问题进来的工单队列是客户支持。

结构决定了东西能不能被找到

每个文档项目开始时井井有条，结束时是一堆杂物。工具要么减缓这个过程，要么加速它。

看看层级如何运作：分类、子页面、交叉链接，以及一个页面能否出现在两个位置而不必复制。再看看到了三百页时会发生什么，为三十页设计的导航在这里会崩溃。

搜索是诚实的测试。用客户会用的词来查询，而不是您的内部词汇。只匹配标题的产品会输掉这场测试，读者最终会出现在您的支持队列里。

标签和相关文章推荐在有人维护时有帮助。没有人会长期手工维护它们，所以优先选择能根据内容生成关联的产品。

撰写、评审，以及让页面保持准确

文档悄无声息地腐烂。三月份正确的页面，到九月份就是一张支持工单，而它看上去毫无问题。

好用的产品带有负责人、复审日期，以及读者看得到的上次检查标记。当撰写者超过两人，草稿状态和评审工作流就变得重要；有人第一次问某个页面修改前是怎么写的，版本历史就变得重要。

复用也值得检查。一项限制、一个价格或一份支持的版本列表，应当只存在一份，并在出现的每个地方被引用，而不是粘贴进十一个页面，到下个季度它们就互相矛盾了。

发布与搜索问题

公开的帮助中心是一个网站，它应该像网站一样运作。

• 干净的URL，在重新组织后依然有效，无法保持时做重定向。
• 可编辑的标题和描述，每篇文章各自设置，而不是由第一行自动生成。
• 快速的页面，文字出现之前不必先加载一个沉重的应用。
• 站点地图在您发布时更新，而不是按没人记得的计划更新。
• 自定义域名，这样内容为您自己的网站而不是厂商的网站积累权重。

最后一点值得在内部争取。文档往往是软件公司表现最好的内容，把它托管在厂商的子域名上，就等于把这些流量拱手让人。

度量，以及唯一重要的指标

页面浏览量几乎什么也说明不了。有两个数字能说明很多。

第一个是没有返回有用结果的搜索，这是一份写好的、接下来要创建什么的清单。第二个是打开过文章的读者之后是否仍然联系了支持，这需要把帮助中心与您的工单系统连接起来。

根据那份清单重写，而不是凭意见。失败最多的那五篇文章，比没人访问的五十篇更值得关注。

这些产品如何定价

作者按席位计费，有时所有人免费阅读，有时按注册的内部读者计费。公开的帮助中心通常按作者数和文章量收费，内部Wiki则按用户。

留意三条界线。自定义域名、版本管理和单点登录，往往各自位于入门方案之上一档。分析的深度是第四条。把帮助中心和支持产品捆绑的厂商，常常把它作为附加项定价而不是包含在内，这是定价页隐藏了什么里汇总的做法之一。

在承诺之前，导出全部内容并读一读输出。Markdown或干净的标记意味着您可以离开。专有格式意味着档案被扣为人质。

从零开始建立帮助中心

第一版应该小到令人尴尬。

取您的支持队列最常收到的二十个问题，认真回答。这涵盖了多数咨询，一周就能完成，而先规划一个完整的结构要花一个季度，期间什么问题也解答不了。

每篇文章都为已经卡住的人而写，也就是先给答案，再做解释。截图老化得很快，所以只在真正有帮助的地方使用，并做好替换它们的准备。

然后让结构自然浮现。写到三十篇之后，分类就会变得显而易见，在第五篇时硬加上去，最后还是得重新整理。

把没有返回结果的搜索词公布为您的写作队列。这是这个分类里唯一永远不会用完、也永远不会猜错的内容计划。