G-genの三木です。突然ですが、技術サポートへのお問合せを送ったことはありますか?今回は、私の経験といくつかの公式資料を基に、技術サポートから素早く回答を貰える質問文(サポートケース)を書くコツをお伝えします。
書き方
1ケースにつき1質問
多くのサービス・製品では1つのサポートケースに、1人のエンジニアが対応します。そのため、1つのケースには複数の質問を記載すると、1人のエンジニアが複数の調査を行ったうえで回答することとなります。
これを避けるため、1つのケースには1つの質問を記載するようにしましょう。複数の質問がある場合は、ケースを分けることで回答スピードが上がります。
迷ったら箇条書き
文章を書くのが苦手な方!朗報です!箇条書きで構いません。
事実を書き並べるだけで大丈夫です。高度なレトリックはいりません。相手に必要な情報が不足なく伝わるように、記述しましょう。
ローコンテクストな記述を意識する
基本的にサポートエンジニアはユーザ側の環境を知らない(知ることが出来ない)ことがほとんどです。そのため、システム名やコード名をはじめとする組織内用語などは使わないようにしましょう。
また、過去のサポートケースでやりとりした内容であっても、新規のケース起票であれば改めて説明する方が結果的に早くレスポンスが来る場合が多いです。
(これは私の体感になりますが、こちらから明示せずとも過去のサポートケースを見た上で返信してもらえることは極僅かです。)
もしどうしても過去のサポートケースを見てほしい場合は、過去のサポートケースIDを直接伝える方が良いでしょう。
状況を正確に共有する
ぜひ、以下の内容を記載するようにしてください。 これがあると、回答する側としてはグッと答えやすくなります。
項目 | 内容 |
---|---|
時刻 | 問題が発生した具体的なタイムスタンプおよび、タイムゾーン |
プロダクト名 | 問題に関連するプロダクト名や、バージョン |
設定値 | 問題が発生しているプロダクトの設定値やリージョンなどの、詳細情報 |
継続の有無 | 問題が断続的なものか、一時的なものか。再現性があるか、ないか。 |
内容
解決したい課題を明確にする
「何を解消したいのか」を明確にしましょう。
それは疑問かもしれませんし、エラーかもしれません。不具合かもしれません。とにかく、あなたが期待する解消したいことを記述してください。
意外に感じるかもしれませんが、これが抜けているサポートケースは少なくありません。
最終的なゴールを共有する
「何を解消したいのか」と並んで大切なことは、「何を実現したいのか」を正確に伝えることです。相手と目的を共有することで、最速でゴールにたどりつくことができます。
場合によっては、「解消したいこと」を無視してゴールに辿り着く方法を案内してもらえる...かもしれません。
すでに試した対応策を連携する
すでに実施済みの対応策があれば、それも連携しましょう。「xxではうまくいかなかった」という情報は、強力な手がかりの一つです。
この際は手順とその結果を正しく伝えてください。
特に結果については自分たちで判断せず、画面ショットやログを添付しましょう。
(質問者側が「失敗だ!」と思っていても、精通しているプロフェッショナルから見るとまた違った意味を持つことがあります。)
添付資料
ログや画面キャプチャを共有する
サポート側はあらゆる可能性を検討してくれます。それこそコマンドのタイプミスから実行権限、サービス側の基盤障害、アップデートの影響...と幅広く調査します。しかし、手がかりが少なければ調査に時間もかかりますし、精度も落ちてしまいます。
そこで、ログや画面キャプチャを率先して提供するようにしましょう。何の変哲もない画面やログに見えても、サポートにとっては大きなヒントが眠っている可能性があります。ただし、ログやエラーメッセージは画面キャプチャでなく、テキスト情報で記載してください。テキストをコピー&ペーストして調査に利用するためです。
(昔の話ですが、画面キャプチャを送ったところ「あなたのコンソールは昔のバージョンだ。新しいバージョンにしたら直る」と爆速で解決したことがあります。)
機密情報以外はマスキング/トリミングしない
ログ等を送る際は、出来るだけマスキングやトリミングをせずにそのまま送るようにしましょう。
(機密情報はもちろんマスキングする必要がありますが、必要以上にマスキングやトリミングをしないように注意してください。
私の経験則からいって、関連する可能性のあるログはそのまま送るほうが早期解決に役立ちます。なお、ログのフォーマットを変更している場合は、その情報も添付しましょう。
参考資料
三木宏昭 (記事一覧)
クラウドソリューション部
HROne→ServerWorks→WealthNavi→G-gen。AWS 11資格、Google Cloud認定全冠。Google Cloud Partner Top Engineer 2024。Google Authorized Trainer
Follow @cloudeep_miki