介绍用户可能遇到的常见问题和处理方法,如果内容较少就直接放在「问题处理」的单页面即可,如果内容较多就将「问题处理」作为目录,每个问题作为一个单独文档。
可以访问 问题处理文档示例 查看对应文档的示例。
详细交代该问题出现的环境、影响范围、问题现象,并适当增加如下辅助信息:
列举导致该问题的一个或多个实际发生过的原因(可以是单一确定原因也可以是多种可能原因)。对于每个原因需要具备如下条件:
详细列举出排查问题的具体步骤,通过问题排查,可以让用户在多个原因中选择最可能的或最确定的原因,并使用合适的解决方案解决该问题。问题排查应注意:
如果只有一个根因,那么需要提供排查步骤,此时建议使用有序列表的形式展示。
如果是多根因且排查步骤不同,此时需使用三级标题的形式列出每个根因,且每个根因下都需要提供详细排查步骤。
解决该问题的具体注意事项、前提条件、操作步骤。
注意:若只有一个根因,则二级标题名称为 “解决方案”;若有多个根因,每个根因对应的解决方案不同,则每个解决方案单独使用一个二级标题,二级标题名称为 “根因 1 的解决方案”、“根因 N 的解决方案”等。
开始操作前需要注意的事项,如果未认真阅读该项可能会出现操作失败、甚至导致更严重的后果。
开始操作步骤前,需要满足的条件。
操作步骤一般使用有序列表的形式展示;若操作步骤比较繁琐,多个步骤间需要添加额外标题进行区分,此时可以使用四级标题的形式列出每个步骤,每个步骤下具体的步骤使用有序列表的形式展示。
如果是在容器平台中进行的操作,可以完整的列出每一步操作的详细步骤;如果是在第三方平台或其他软件中操作,仅给出对应的关键步骤即可。
原因:非容器平台操作,若写的过于详细,我们无法保证在其界面变化时能够及时更新文档,由此可能会带来许多问题,为确保文档的长期可用性,第三方平台操作步骤描述应遵循以下原则:
- 重点突出核心步骤和关键操作。
- 避免过度依赖特定界面细节。
- 保持操作步骤说明的通用性和灵活性。
- 确保用户理解操作目的和基本流程即可。
...
该部分内容和根因 1 的解决方案形式一致,此处不再赘述。
提供预防再次出现该问题的具体措施(建议、命令、操作、前提等)。
可以存放一些文档中用到的内容,但是该内容不方便放到正文中,例如:工具使用方式、参考资料等内容。