在指南或流程性文章中使用故障排除章节，使解决方案紧邻操作步骤。与支持团队和产品经理合作，收集常见错误并将其纳入文档。
已知问题
已知问题是故障排除内容的一个子集，专门用于应对 bug、UX/UI 问题以及其他会产生大量支持工单的产品异常。故障排除内容可以描述用户*可能*会遇到的错误，而已知问题则阐述用户*必定*会遇到的问题。
和所有故障排除内容一样，已知问题可以作为文章中的章节，也可以是独立的文章。如果已知问题适用于特定文章，请在该文章中记录；如果已知问题涉及一组文章或一类功能，或某个产品/功能有多个已知问题需要归类，请新建专门的“NAME 的已知问题”文章。
针对某个产品或功能的已知问题内容不必穷尽。与其他故障排除内容不同，有些已知问题可能暂时没有解决办法。记录没有解决办法的问题，目的是帮助用户确认该问题确实存在，并在 GitHub 已确认暂无解决方案后，避免他们继续浪费时间去寻找不存在的办法。
产品和功能负责人（PM 与 EM）应协助规划并审阅已知问题内容。
使用已知问题来解释以下情形。
- 产品行为经常与用户预期相悖，但尚未列入修复优先级。
- 行为经常阻止用户在常见场景下使用该产品或功能。
- 罕见或严重的 bug，GitHub 尚未优先修复，也未在产品说明或现有 GitHub 文档中解释。
如何编写故障排除内容
- 可使用任意 GitHub Docs 内容类型创建故障排除章节。
- 在可能的情况下，将故障排除内容保留在流程性内容或指南内部。
- 当需要将其独立出来更为合理时（例如针对特定主题的故障排除内容量较大），可以创建单独的故障排除文章。
- 如果某个产品或功能拥有众多故障排除文章，可创建故障排除主题映射，例如 故障排除 SSH。
故障排除内容的标题指南
- 故障排除 FEATURE
- 错误：ERROR NAME
- PRODUCT 的已知问题
故障排除内容示例
- 故障排除 SSH
- 使用负载均衡器的 GitHub Enterprise Server
- 已知问题（出现在 GitHub Enterprise Server 发行说明中）
- 错误：我们正在进行 SSH 密钥审计