エラーメッセージごとの対応方法の書き方
エラーメッセージごとの対応方法の種類
エラーメッセージごとの対応方法は、以下のパターンで作成します。
単一のエラーの原因と対処方法を伝える記事の構成
1.質問（タイトル）
文頭に Q. をつけ、エラーの状態を書きます。読みづらい長文にならない限り、基本的にエラーメッセージをそのまま記載します。エラーメッセージは「 」で囲みます。
プロダクトのHeadingルールに則り、句点は省略します。
例外的に口語体で表現しますが、「 」は使用しません。
2.リード
エラーがどの画面で、どういったときに起きるかなどを簡潔に書きます。タイトルでエラーメッセージを省略した場合には、必ずエラーメッセージを記載します。
本文のスタイルを適用します。
3.原因（見出し）
文頭にA. をつけ、原因を簡潔に記載します。
見出し1のスタイルを適用します。
例外的に口語体で表現しますが、「 」は使用しません。
Headingの見出しの書き方に則り、句点は省略します。
4.説明
原因を詳細に説明します。どのような条件で操作をするとそのエラーが起こるのかを説明します。
本文のスタイルを適用します。
5.対処方法
対処方法を書きます。
手順が複数の工程に分かれる場合は、見出しで工程ごとに分割し、操作手順記事と同じルールで記載します。
見出し2と本文のスタイルを適用します。
記載例
- Q. 「書類の作成に失敗しました。必須項目の内容を確認してください。」と表示される場合は？
- Q. 評価シート画面で「編集内容の保存に失敗しました。更新権限があるフォームの下書きが存在しません。」というエラーが出ました
いくつかのエラーをまとめた記事の構成
1つの場面で表示される複数のエラーをまとめたいとき。
1.タイトル
エラーが表示される場面を明記し、「エラーメッセージ」をタイトルに含めます。
- XXXX時のエラーメッセージ
- XXXXで表示されるエラーメッセージ
2.エラー
文頭に エラー をつけ、エラーメッセージを「 」で囲みます。エラーメッセージが複数の文で構成されている場合は、最初の文を抜粋しても構いません。
見出し1のスタイルを適用します。
3.回答
単一のエラーの原因と対処方法を伝える場合の見出しと同様。
見出し2のスタイルを適用します。
4.説明
単一のエラーの原因と対処方法を伝える場合の説明と同様。
本文のスタイルを適用します。