これは、Discourseで効果的なバグレポートを作成し、バグ修正の機会を最大化するためのガイドです。
必要なユーザーレベル: 誰でもバグを報告可能
良いバグレポートを書くことは、Discourseチームが問題を効率的に修正するために不可欠です。このガイドでは、バグレポートを明確で簡潔、かつ実行可能なものにするための手順とベストプラクティスについて解説します。
概要
このドキュメントでは、以下の内容を扱います。
- 再現手順と具体的な詳細を提供することの重要性
- 問題点と期待される動作の記述方法
- 異なるプラットフォームでの報告におけるベストプラクティス
- レポートでの適切なトーンの維持
- 一般的な落とし穴とその解決策
効果的なバグレポートの作成手順
優先度/重大度
バグ修正の緊急性を判断します。誰もが自分の問題を迅速に解決してほしいと考えていますが、機能に重大な影響を与える深刻な問題に対してのみ、最高優先度を割り当ててください。
プラットフォーム
バグが観察された環境を常に指定してください。これには以下が含まれます:
- デバイスタイプ (デスクトップ、モバイル、タッチスクリーン、タブレット)
- オペレーティングシステムとそのバージョン
- ウェブブラウザとそのバージョン
可能であれば、複数のプラットフォームでバグを再現し、その存在を確認してください。
説明
簡潔に記述してください。余計な詳細を避け、問題をシンプルに説明してください。個別に報告できる場合は、異なる問題を分離してください。明確な説明フォーマットには以下が含まれます:
実際の結果: 何が起きているか？
期待される結果: 何が起きるべきだったか？
読者がすでに知っていることを前提としないでください。何が見えるべきだったか、または発生するべきだったかを明確にしてください。
再現手順
バグが一貫して再現できることを確認してください。Discourseのホーム画面から始まる手順で記述してください。バグがランダムに発生する場合は、発生頻度を指定してください（例：10回の試行のうち1回）。UI/UXに関連するバグの場合は、明確にするためにスクリーンショットや動画を追加してください。
トーン
尊重され、丁寧なトーンを維持してください。バグレポートで不満を表明しないでください。有毒な言語や行動は、レポートの遅延や無視の原因となります。
テンプレート
このテンプレートを使用して、新しいバグレポートのトピックをすばやく開始してください:
優先度/重大度:
プラットフォーム:
説明:
再現手順:
ベストプラクティス
- セーフモードで再現する: 報告する前に、カスタマイズが原因である可能性がある場合は、Discourseのセーフモードで問題を再現してみてください。
- 前提を疑う: バグレポートは多くの場合、誤った前提から生じます。レポート内でも、自分が持っているかもしれない前提を疑い、明確にしてください。
- 詳細に記述する: 厄介なバグや稀なバグの場合、可能な限り多くの詳細を提供してください。エラーメッセージやログファイルなど、関連する可能性のあるものをすべて含めてください。
一般的な問題と解決策
問題: バグを一貫して再現できない。
解決策: バグが発生する環境と条件を文書化してください。パターンや共通点に注意してください。
問題: バグレポートへの返信がない。
解決策: レポートが詳細でありながら簡潔で、丁寧なトーンで書かれていることを確認してください。
よくある質問
Q: 詳細なレポートを作成する時間がない場合はどうすればよいですか？
A: 持っている情報でレポートを開くことは依然として役立ちます。後ほど詳細を更新することを示してください。
Q: バグレポートはどこに投稿すべきですか？
A: 適切なカテゴリを使用してください - バグレポートは Contribute > Bug カテゴリに投稿する必要があります。