"故障排除" 类文章的最佳实践

Contributors Contributors 建立于:

"故障排除" 类文章针对的是 “如何修复...?” 这样的问题。通常是用户使用产品、服务或功能时遇到了麻烦。这类文章指导用户确定、诊断和解决一些常见问题,并提供简明扼要的解决方案。和 "关于" 或 "如何使用" 文章介绍或解释如何使用 Mozilla 的产品和服务不同,"故障排除" 类文章解决具体问题,确保用户尽快回到能够顺利使用产品或服务的状态。

何时撰写 "故障排除" 类文章

在以下情形下,请考虑撰写一篇 "故障排除" 类文章:

  • 用户经常碰到关于产品、服务或功能的某个具体问题。
  • 有一个已知问题,用户可能不那么容易自己知道怎么解决。
  • 更新、更改或故障导致用户需要帮助解决问题。

撰写 "故障排除" 类文章的最佳实践

  • 确定问题:请一开始就把问题描述清楚,这样读者就知道他们来对了地方——文章和他们要解决的问题有关。
  • 解释原因:如果可能,简要介绍为什么会出现问题,这有助于读者后续避免此问题。
  • 提供有步骤的解决指导:把解决问题的过程细化为清晰、容易执行的步骤。

文章结构

  • 标题:文章标题应该切合文章内容并利于用户搜索。关于任务的文章标题应该使用动词开头,不过要避免动名词。你还需要避免使用 “如何...” 这样的标题。如何使用” 的标题是完成任务的,而 “故障排除” 的标题是解决问题的。请在标题中使用“解决“和”处理“等关键词。使用句子的大小写方式。标题的字数不要超过60个字符,因为谷歌通常只显示标题的前50–60个字符。
  • 摘要:本节描述用户碰到问题的具体情况和现象。描述应该使用清晰明确的语言,尽量避免专业词汇,保证多数用户可以理解。可以包含诸如“不能”、“不工作”、“崩溃”等关键词帮助搜索。
  • 文章主体:文章主体包含诊断和解决问题的纵深信息。它还可以包括结果和例子。如果文章有多个相关的步骤的话,可以增加一个目录部分。请使用 H2 作为小节标题。在开始介绍步骤之前,现说明目标。(比如,“重置 Firefox 打印机设置”)。
    • 前提:这部分有助于用户了解问题发生的底层因素,可以描述在操作之前用户需要知道相关的信息或操作。
    • 场景:(可选)此处撰写可能发生问题的理论场景或常见原因。
    • 步骤:请使用有序号列表了诊断或叙述解决问题的操作步骤。在展开步骤之前,请说明目的。请避免使用嵌套步骤。
    • 结果:(可选)此处描写完成一些步骤之后的结果。
    • 例子:(可选)此处添加支持操作任务的例子。
    • 后续:(可选)此处添加用户完成操作步骤之后需要知道的信息。
  • 了解更多链接:请使用 H3 作为本节标题。它不应出现在目录中。使用无序号的列表展示不超过四个链接。

文章样例

这篇文章对您有帮助吗?

请稍候...

此文章在这些用户的协助下写成:

Illustration of hands

志愿者

分享知识并培养专业技能。解答问题并改进我们的知识库。

详细了解