Close

分类

故障排除文章模板

作者: Atlassian

Document common problems and how to solve them

使用模板
故障排除文章模板

撰写故障排除文章,以帮助客户解决常见问题并自行找到解决方案。我们的故障排除文章模板为您提供了所需的结构,帮助您阐明问题、详细说明解决方案并显示相关文章(您可以使用标签和“按标签分类的内容”宏来自动操作,以跟踪相关文章)。授之以渔,并让支持团队有更多时间来处理更复杂的任务。

如何使用 故障排除文章 模板

第 1 步:描述问题

像这样的文章很容易吸引人直接去研究解决方案,但描述问题是撰写有效内容的重要组成部分。读者需要能够判断您的文章能否解决他们所面对的问题。想一想您的受众面对此问题的情况,并运用与这些经历相关的术语和示例来阐明该问题。

第 2 步:提供分步解决方案

描述问题后,需要说明如何解决问题。用编号列表的形式写出分步解决方案。使用读者了解并明白的术语,一次完成一个步骤。如有可能,借助图片说明步骤。这样,阅读文章的人就会知道在此过程中每一步的具体情况。如果解决方案可能不止一种,那么最好的选择就是坚持使用撰写文章时最常用的解决方案。如果您确实认为需要给读者提供更多选择,则可以使用扩展功能创建一个可折叠的面板,在其中添加其他解决方案。

第 2 步:提供分步解决方案

第 3 步:显示相关文章

有时,您会遇到一篇与您的问题相似但并不完全相同的文章。有时,详细了解某个方案起作用的方法可以帮助您预防以后出现问题。通过在故障排除文章中应用标签以及使用标签宏内容(已包含在此模板中),可以自动显示相关文章和页面。您只需确保对所有相关页面使用相同的标签即可。


Atlassian 是一家企业软件公司,面向软件开发人员、项目经理和内容管理人员开发商品。

  • AWS architecture diagram template

    Lucidchart

    AWS 架构图

    将基础架构可视化,以便更好地明确劣势并确定有待优化的方面。

    使用模板 了解更多
  • DevOps runbook template

    Atlassian

    DevOps 运行手册

    让运维团队做好准备,快速响应系统警报和中断。

    使用模板 了解更多
  • DevOps change management template

    Atlassian

    DevOps 变更管理

    使用此模板评估变更管理绩效并降低风险。

    使用模板 了解更多