開発
バグ報告テンプレート（Markdown）
最初の一回で誰かが再現できれば、バグはより早く修正されます。このテンプレートは事実を伝える順番を決めています。一文の要約、環境情報、番号付きの手順、期待した動作、実際の動作、そして証拠です。入力してPDFに出力しましょう。
このテンプレートをエディターで開く- カテゴリー
- 開発
- デフォルトスタイル
- テクニカル
使う場面
課題をトラッカーの外に送る必要があるとき、たとえば取引先やクライアント、サポート窓口、記録を残したいマネージャーに送るときに使います。読み手は問題が起きた場面を見ていない開発者やテスターであることが多いため、各項目はあなたに聞かずに済むよう答えを用意しています。
含まれる内容
- プロジェクト名、氏名、日付を入力する欄と、深刻度の行を含むヘッダー。
- アプリのバージョン、ブラウザ、OS、デバイス種別をまとめた環境情報の表。
- 番号付きの再現手順、期待される動作と実際の動作、証拠と回避策の項目。
より良い文書にするヒント
- エラー文は説明せずそのままコピーしましょう。ログの抜粋はコードブロックに貼ると余白がそのまま保たれます。認証情報や個人情報は先に取り除いてください。
- 問題を再現できる最小限の入力まで手順を削りましょう。このテンプレートはテクニカルスタイルで開くため、表やコードが見やすく表示されます。
テンプレートのプレビュー
バグ報告: プロジェクトまたはテーマ
報告者: お名前 · 日付: 日付
深刻度: 低 / 中 / 高
概要
問題とそれを引き起こす操作を一文で説明してください。
環境
| 項目 | 値 |
|---|---|
| アプリバージョン | バージョンを記載 |
| ブラウザ / OS | 詳細を記載 |
| デバイス | デスクトップ / モバイル |
再現手順
- 該当ページを開く。
- 必要最小限の入力を行う。
- 操作を実行する。
期待される動作
本来起こるべきことを説明してください。
実際の動作
実際に起きたことを、正確なエラー文言とともに説明してください。
証拠
スクリーンショットまたは個人情報を除去したログの抜粋を添付してください。認証情報や個人データは削除してください。
回避策
一時的な回避策があれば記録してください。
氏名や日付などの入力欄は、エディターでテンプレートを開くと置き換えられます。