技术文档质量

概述

技术文档质量是产品帮助中心质量的重要组成部分。对于帮助中心而言，理解用户在技术文档使用中的信息行为，能帮助技术文档写作人员开发出对用户更友好的产品资料。

文档质量评估方式

• 质量控制

  1. 文档测试（随版本专业团队测试、模拟小白测试、专项测试）
  2. 文档上线 1+1 审核（正确性编辑、校验）
  3. 低错检查

• 质量评估

  1. 用户使用文档的数据分析（跳出率/点击量/PV/负反馈/提问题量）
  2. 对服务侧的引导分析（工单拦截率、点赞/点踩数、工单趋势分析）
  3. 内部评估（比对 DQTI 制定的 checklist）

高质量文档写作的要素

在评估帮助中心质量时，常常考虑帮助中心信息的 易找性、易用性、易理解性。

易使用

• 面向任务：帮助用户完成任务，已达到他们使用产品的目的。
• 精确：避免错误，称述事实的真相。
• 完整：包含所有必要的内容（仅限于必要的内容）。

易理解

• 清晰：避免使用含糊不清，晦涩难懂的词语。让读者在第一次阅读这句句子时，即了解到句子所要表达的所有意思。
• 具体：提供适当的例子、情景介绍、明喻、类比、具体的语法举例、图表。
• 风格：使用妆具正确性和精准性的词汇和词组，培养严谨的写作习惯。

易查找

• 组织：连贯的内容组织和编排，符合用户的使用场景和目的。
• 可检索：内容的呈现方式需要使用户能够快速和容易的定位到所需要的具体内容。
• 视觉效果：使用布局、插图、颜色、图标和其他图形化的表达方式来形成具有吸引力和需要强调的文字。

文档质量