在指南或程序性文章中使用故障排除部分，以便将解决方案与步骤紧密联系在一起。与支持团队和产品经理合作，找出常见错误并将其包含在文档中。
已知问题
已知问题是故障排除内容的一个子集，专门用于响应 bug、UX/UI 问题以及其他导致大量支持工单的产品缺陷。故障排除内容可以描述用户_可能_遇到的错误，而已知问题则解释用户_将_遇到的问题。
与所有故障排除内容一样，已知问题可以是文章中的一个部分，也可以是独立的文章。如果已知问题适用于特定文章，请在该文章中记录它。如果已知问题适用于一组特定的文章或功能的概念分组，或者某个产品或功能有多个应分组在一起的已知问题，请创建一个名为“NAME 的已知问题”的专用文章。
产品或功能的已知问题内容无需面面俱到。与其他故障排除内容不同，某些已知问题可能没有解决方法。记录没有解决方法的问题的目的是帮助用户确认问题的存在，并节省他们在 GitHub 已确定没有解决方法后仍在寻找不存在的解决方案的时间。
产品和功能所有者（PM 和 EM）应帮助规划和审查已知问题内容。
使用已知问题来解释以下情况。
- 产品行为经常与用户的预期相矛盾，但尚未确定修复优先级。
- 经常阻止用户将产品或功能用于常见目的的行为。
- GitHub 尚未确定修复优先级的罕见或严重错误，并且这些错误未在产品中或 GitHub Docs 中的现有内容中解释。
如何撰写故障排除内容
- 使用任何 GitHub Docs 内容类型来创建故障排除部分。
- 尽可能将故障排除内容包含在程序性内容或指南中。
- 当将故障排除内容单独保存更有意义时（例如，当某个特定主题上有大量故障排除内容时），您可以创建故障排除文章。
- 如果产品或功能有很多故障排除文章，例如“SSH 故障排除”，您可以创建一个故障排除地图主题。
故障排除内容的标题指南
- 功能故障排除
- 错误：错误名称
- 产品已知问题
故障排除内容示例
- “SSH 故障排除”
- “使用 GitHub Enterprise Server 与负载均衡器”
- GitHub Enterprise Server 发行说明中的“已知问题”
- “错误：我们正在审核 SSH 密钥”