"如何使用" 类文章的最佳实践

修订信息
  • 修订编号: 279158
  • 建立于
  • 创建者: wxie
  • 备注: 初次翻译。
  • 已审阅:
  • 已审阅:
  • 审核人: wxie2016
  • 已核准?
  • 这是当前最新的版本吗?
  • 可进行本地化:
修订原文
修订内容

“如何使用” 类文章回答“怎么办?”的问题。它们帮助读者了解完成某项任务或流程的操作步骤。它们把复杂产品和服务分解为简单的操作步骤,让读者可以控制每个步骤。"如何使用" 类文章是对 "关于" 类文章的支持和补充。"关于" 类文章向用户介绍了概念和功能,"如何使用" 类文章手把手教会用户使用这些功能获益的操作步骤。

何时需要撰写 "如何使用" 类文章?

请在以下情形下考虑撰写一篇 "如何使用" 类文章:

  • 介绍新产品和功能:每当我们发布新产品或引入新功能时,为用户提供一个产品或功能的使用路线图非常重要。撰写一篇 "如何使用" 类文章可以指导用户设置、使用以及优化新功能,并帮助他们从一开始就能正确获得新功能的价值。
  • 增强用户最现有功能的使用体验:如果一个产品的功能由于复杂性或缺乏特定的知识而未被用户充分使用,那么它可能需要一个 "如何使用" 类文章。撰写一个全面解锁该功能的详细指导能够助力用户增强使用体验和生产力。
  • 解决共有问题:当用户面临重复发生的问题或错误时,"如何使用" 类文章就是救助热线。提供一个针对这些问题的详细步骤可以帮助用户自主解决问题。请注意重点在于将解决方法做成清晰的步骤,确保这些共有的问题能够得到处理。

撰写 "如何使用" 类文章的最佳实践

创建有效的 "如何解决" 类文章需要清晰、简明和全面。以下是我们的做法:

  • 分步骤指导:把处理过程分解成用户容易操作的明确步骤,避免含糊不清。
  • 使用视觉辅助资料:在文章中使用截图、图片等视觉资料来辅助操作步骤,让复杂的操作变得容易理解。
  • 提示和警告:为了保证用户的流畅体验,可以重点指出可能的陷阱和最佳实践的小技巧。
  • 相关内容: 最后请推荐一些额外的资料指导用户进一步学习。

文章结构

  • 标题:文章标题应该切合文章内容并利于用户搜索。关于任务的文章标题可以使用动词开头,不过要避免动名词。你还需要避免使用 “如何...” 这样的标题。 “如何使用” 的标题是完成任务的,而 “故障排除” 的标题是解决问题的。使用句子的大小写方式。标题的字数不要超过60个字符,因为谷歌通常只显示标题的前50–60个字符。
  • 摘要:摘要展示文章的重点,帮助读者判读文章是否自己所需。请在摘要部分关注用户的目的,而不是产品的功能。摘要不应超过140个字符,因为搜索引擎会切去超出部分。
  • 文章主体:文章主体包含诊断和解决问题的纵深信息。它还可以包括结果和例子。如果文章有多个相关的步骤的话,可以增加一个目录部分。请使用 H2 作为小节标题。在开始介绍步骤之前,现说明目标。(比如,“修改密码”)。
    • 前提:(可选)提供需要完成任务的预备知识或动作。
    • 场景:(可选) 提供概念信息或背景信息。
    • 步骤:使用有序号的列表来叙述操作步骤和动作。请避免嵌套的步骤。
    • 结果:(可选)描述步骤完成后的预期结果。
    • 例子:(可选)描写支持任务的例子。
    • 后续条件:(可选)添加完成任务后一些用户需要了解或执行的动作。
  • 了解更多的链接:请使用 H3 作为了解更多的标题。它不应出现在目录中。使用无序号的列表提供不超过四个进一步了解文章相关内容的链接。

文章样例