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