単一のエグゼキューターまたはそのグループでプロジェクトに取り組む過程で、あなたがデザイナーであるか、開発者を雇った最終顧客であるかは関係ありません。あなたは常に同じ結果を目指して努力します。 ほとんどの場合、アプリケーションをテストする過程で、いくつかのエラーやコメントが検出されます。 この記事では、開発者が長い間頭を悩ませて、問題を解決する前に正確に何が問題であるかを考える必要がないように、どのようにコミュニケーションするのが最善かという観点を表明するよう努めています。 これにより、プロジェクトの実装期限と予算への準拠が保証されます。また、開発者は、発見されたエラーを繰り返し修正するのに役立つ詳細を無駄に検索するのではなく、新しい機能の追加により多くの時間を費やすことができます。
「機能しません。」
問題が見つかった場合、最小限の説明を記載した電子メールをすぐに送信し、開発者がすぐにそれを見てすべてを理解すると想定するのは非常に魅力的です。 ただし、問題を詳細に説明するのにほんの数分を費やすだけで、開発者側の誤解を防ぐことができ、時間を節約できます。または自分でそれを再現しようとして時間を費やします。
良い報告
優れたバグレポートは、開発者に3つの重要なことを伝えます。
- 予想される動作。
- 実際に何が起こったのか。
- あなたは何をしましたか。
予想される動作
「エラー」には2つのタイプがあります。最初のケースでは、何かが壊れています-エラーメッセージが表示されるか、ダウンロードしたデータがなくなっているか、フォームを介してデータを送信してもデータが保存されません。 一般に、このようなエラーは非常に簡単に検出でき、報告も簡単です。この場合、開発者はこのエラーを再現して修正できるように、この時点で何をしているか入力していることを知る必要があります。
2番目のタイプのエラーは、アプリケーションが期待どおりに動作しないことです。 これは、開発者が技術的なタスクの一部を誤って実装した場合に発生する可能性がありますが、アプリケーションが単に希望どおりに機能しない可能性があります。 この場合、開発者はそれが意図したとおりに機能し、本当に「機能する」と信じていますが、実際には間違っている可能性があります。 エラーメッセージでこの機能が機能しないと言う場合、開発者はアプリケーションのこの部分のエラーを見つけるために多くの時間を費やすことができますが、期待どおりに機能しないことを理解する必要があります。 メッセージにアプリケーションに期待することを書くと、開発者は理解しやすくなります。「うーん、彼は「A」が発生することを望んでいますが、実際には「B」が発生しており、正しい決定がはるかに速く行われます。
本当に起こったこと
実際、非常にまれに、何も起こらないことを「何も起こらない」と呼ぶことができますが、エラーメッセージには「何も起こらない」と書かれていることが非常に多くあります。 実際に期待される結果に関して「何も」起こらなかった場合、文字通りいくつかのフレーズで説明する価値があります。 たとえば、フォームの「送信」ボタンをクリックしても、フォームデータが送信されず、次のページに移動しない場合、次のように記述できます。
「フォームは送信されません-私は同じページに残ります 。 」
ただし、フォームを送信した結果、空白のページが表示される場合があります。
「フォームを送信すると、空白のページが読み込まれます。」
画面にエラーメッセージが表示された場合は、メッセージに含めてください。 コピーして貼り付けてください。
Internet Explorerを使用している場合、ブラウザはサーバーが表示するエラーメッセージではなく、単に一般的なエラーページを表示する場合があります。 IEがサーバーから送信されたエラーメッセージを正確に表示することを確認します。 これを行うには、
Tools > Internet Options > Advanced
移動してから、下にスクロールして[
Show friendly http error messages
]オプションをオフにします。 IE 7ユーザーの場合、
> >
] に移動し、 [
http
する ]オプションを有効にし
http
。
あなたは何をしましたか
開発者はこの情報に興味がありますが、あなたが何か間違ったことをしたと言っているからではありません。 いや 特定の一連のアクションの結果として、または特定のデータが入力された場合にのみエラーが発生することが非常に頻繁に発生します。 開発者に伝えることができる情報が多いほど、見た問題を再現して修正できる可能性が高くなります。 次の情報をメッセージに含めることをお勧めします。
アクションのシーケンス
可能であれば、正しい順序で実行した内容を正確にリストします。 戻ってきたら、これらのすべての手順を繰り返してください。問題は何度も発生します。これは素晴らしいことです。問題を繰り返すために行ったすべてのことを詳細に書き留めてください。 開発者は、問題を再現するために時間を節約してくれたことを喜んでいます。 たとえそれを再現できなくても、問題が本当に発生したことを疑う人はいません。 この場合、この条件をどのように達成したかを説明してください。
入力されたデータ
フォームにデータを入力した後に問題が発生した場合は、このデータをエラーメッセージに含めてください。 サーバーに何か（写真など）をアップロードする場合は、追加できます。
ブラウザのアドレスバーからURLをコピーして貼り付けて、その時点でどのページにいたかを開発者が正確に把握できると便利な場合があります。
ブラウザとオペレーティングシステム
Webアプリケーションの場合、問題は1つのブラウザーでのみ発生します。 （あなたの）開発者にシステムに関する完全な情報（バージョン番号を含む）を提供して、環境を再現し、問題がないかテストしてください。
効果的なエラーメッセージは、述べられた問題をどれだけ迅速に解決できるかに大きく影響し、関係する両方の関係者のフラストレーションを防ぐことができます。 上記の情報を含めると、たとえそれが役に立たないことが判明したとしても、開発者はより高い敬意をもってあなたを扱います。 ストーリー全体を書く必要はありません。以下に関する重要な情報を含むわかりやすい行をいくつか書くだけです。
- 予想される動作。
- 実際に何が起こったのか。 そして
- あなたは何をしましたか。
これは、既存の問題から最も複雑な問題を強調するのに十分です。 そして、エラーが繰り返される可能性がある場合、それはすでに除去の半分です。
私の翻訳を読んで読んでくれている皆さんに感謝します。 コメントや追加に感謝します。 バグ修正に頑張ってください！
Web Optimizator：サイトの読み込み速度の確認