故障排除内容类型

故障排除内容包括用户可能会遇到的内置错误、向支持人员报告的常见问题，以及用户在完成任务时可能遇到的情况。

本文内容

使用指南或过程文章中的故障排除部分拉近解决方案与过程的距离。 请与支持和产品经理协作，以发现常见错误并将其包含在文档中。

已知问题

已知问题是专门用于响应 bug、UX/UI 问题和其他生成大量支持工单的产品问题的故障排除内容的子集。 其中，故障排除内容可以描述用户可能遇到的错误，而已知问题可解释用户将遇到的问题。

与所有故障排除内容一样，已知问题可以是文章中的部分或独立文章。 如果已知问题适用于特定文章，请在该文章中记录它。 如果已知问题适用于一组特定的文章或功能的概念性分组，或者产品或功能具有多个应组合在一起的已知问题，请创建专用的“NAME 已知问题”文章。

产品或功能的已知问题内容不需要全面。 与其他故障排除内容不同，某些已知问题可能没有变通方法。 在没有变通方法的情况下记录问题的目的是帮助人们确认问题存在，并节省他们在 GitHub 确定不存在变通方法后搜索尚不存在的解决方案的时间。

产品和功能所有者（PM 和 EM）应帮助计划和查看已知问题内容。

使用已知问题来解释以下情况。

  • 经常与人们的期望相矛盾但尚未确定修正优先级的产品行为。
  • 经常阻止将产品或功能用于常规用途的行为。
  • GitHub 尚未确定修复优先级的罕见或严重 bug，以及未在产品中或未通过 GitHub Docs 的现有内容解释的罕见或严重 bug。

如何编写故障排除内容

  • 使用任何 GitHub Docs 内容类型创建故障排除部分。
  • 尽可能保留过程内容或指南中包含的故障排除内容。
  • 如果有必要将其分开（例如当特定主题存在大量故障排除内容时），可以创建故障排除文章。
  • 如果产品或功能包含许多故障排除文章（例如 SSH 故障排除），可以创建故障排除映射主题。

故障排除内容的标题指南

  • 故障排除功能
  • 错误：错误名称
  • 产品的已知问题

故障排除内容的示例