Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 2.3 KB

template-troubleshooting.md

File metadata and controls

62 lines (36 loc) · 2.3 KB
title summary
故障现象(与文档一级标题保持一致)
介绍 xxx 故障的排查思路、可能的原因和解决方法。

故障现象(与文首 metadata 中的 title 名称保持一致)

模版说明:

  • 本文档为故障处理类模板,包含故障诊断和解决方案信息。你可直接复制使用,并删除模板中不需要的说明。该类文档示例:读写延迟增加
  • 请在 TOC.md 中合适的位置加目录(思考用户最有可能在哪里找文档)。
  • 文内标题级别不可跳级,尽量避免使用五级标题。

本文档介绍 xxx 故障的排查思路、可能的原因和解决方法。

常见原因

将导致该故障最常见的原因放到这个小节中,帮助用户优先排查这些大概率的原因。

常见原因 1 说明

这里简单描述常见原因 1 的背景信息和给系统带来的影响。

现象诊断:

这里给出故障诊断信息,如何判断目前的故障是否是由于原因 1 引起的。

解决方案:

这里列出由于原因 1 引起的故障对应的解决方案。请根据该方案内容是有无先后顺序,判断使用无序列表或者步骤呈现信息。

如果方案内容是一系列的步骤,请使用步骤。例如:

  1. 步骤 1 的内容
  2. 步骤 2 的内容
  3. 步骤 3 的内容

解决方案给出后,需要请用户再次检查是否按照上述方案执行后,之前的故障现象会消除。如果仍未解决故障,应该如何处理。

常见原因 2 说明

这里简单描述常见原因 2 的背景信息和给系统带来的影响。

现象诊断:

这里给出故障诊断信息,如何判断目前的故障是否是由于原因 2 引起的。

解决方案:

这里列出由于原因 2 引起的故障对应的解决方案。请根据该方案内容是有无先后顺序,判断使用无序列表或者步骤呈现信息。

如果方案内容是一系列的步骤,请使用步骤。例如:

  1. 步骤 1 的内容
  2. 步骤 2 的内容
  3. 步骤 3 的内容

解决方案给出后,需要请用户再次检查是否按照上述方案执行后,之前的故障现象会消除。如果仍未解决故障,应该如何处理。

其他原因

将导致该故障不是特别常见的原因放到这个小节中。