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