Close

8 月 4 日から始まる、毎週 20 分間のエピソードでチームのコラボレーションを改善する方法をご覧ください。無料登録はこちら →

カテゴリー

トラブルシューティング記事テンプレート

著者: アトラシアン

一般的な問題とその解決策を文書化する

テンプレートを使用する
トラブルシューティング記事テンプレート

トラブルシューティング記事を作成することで、顧客が自力で一般的な問題に対処し、解決策を特定できるよう支援します。アトラシアンのトラブルシューティング記事テンプレートでは、課題の説明、解決策の詳述、関連記事の表示 (ラベルおよびラベル別コンテンツ マクロを使用して自動で実行し、関連記事を追跡可能) に必要な構造が提供されます。顧客に自力での解決方法を教えることで、サポート チームがより複雑なタスクへの対応に多くの時間を費やせるようにします。

トラブルシューティング記事 テンプレートの使用方法

ステップ 1. 問題を説明する

このような記事では、真っ先に解決策を記載してしまいがちです。しかし、役に立つ記事を作成するには問題の説明が非常に重要です。読者が、自分に起こっている問題に関連する記事かどうかを判断できるようにする必要があります。該当する問題が読者に対してどのように発生しているのかを考え、読者の立場に立って関連性の高い用語と例を使用しながら問題を説明しましょう。

ステップ 2. ステップ バイ ステップの解決策を提示する

問題について説明したら、次にその解決方法を説明します。番号付きのリストを使用し、ステップ バイ ステップの解決策を記載します。読者が理解できる用語を使用し、ステップを 1 つずつ説明します。可能な限り、各ステップを画像で説明しましょう。それにより、記事の読者が各ステップを視覚的に理解できます。解決策が複数考えられる場合は、最も一般的な方法のみを記載することをお勧めします。複数のオプションを提供する必要があるという確信がある場合は、展開を使用して折りたたみ可能なパネルを作成し、ほかの解決策を含めることができます。

ステップ 2. ステップ バイ ステップの解決策を提示する

ステップ 3. 関連記事を表示する

自分が直面している問題とまったく同じではないものの、似ている問題に関する記事を目にすることがあります。また、何かの仕組みをより詳しく知ることで、後で問題の発生を防げることもあります。トラブルシューティング記事にラベルを付け、(このテンプレートにすでに含まれている) ラベル別コンテンツ マクロを使用することで、関連する記事とページを自動で表示できます。関連するすべてのページに対し、必ず同じラベルを使用してください。


アトラシアンは、ソフトウェア開発者、プロジェクトマネージャー、コンテンツ管理向けの製品を開発するエンタープライズソフトウェア会社です。

  • AWS architecture diagram template

    Lucidchart

    AWS アーキテクチャ図

    インフラストラクチャを視覚化し、弱点と改善点をより正確に特定します。

  • DevOps runbook template

    アトラシアン

    DevOps ランブック

    運用チームが素早くシステム アラートや障害に対応できるよう準備します。

  • DevOps change management template

    アトラシアン

    DevOps 変更管理

    このテンプレートを使用して変更管理パフォーマンスを評価し、リスクを軽減します。