BugIt3分で読めます

トリアージされやすいバグタイトルの書き方

バグタイトルは、ほとんどの人が読む唯一の1行です。何を書き、何を省くか、そして登録する前にトラッカーの一覧で試す方法を紹介します。

曖昧なバグタイトルと、対象領域、症状、条件を明記したわかりやすいタイトルの比較。

忙しいトラッカーを開いて、一覧表示を見てください。チケットごとに1行ずつ、ID、ステータス、タイトルが並んでいます。それ以外は何もありません。バグが受け付けられるか、無視されるか、別のチケットに統合されるか、質問付きで差し戻されるかは、この1行で決まります。しかもその判断は、誰かが説明を開く前に下されることがよくあります。

つまり、タイトルはあなたが書くどの行よりも多くの仕事をします。その役目を果たせるタイトルの書き方を紹介します。

タイトルの役割

一覧表示の中で、タイトルには3つの役割があります。

  • どこなのかを伝える。 対象の領域、画面、コマンドです。適切な人が気づけるようにします。
  • 何がおかしいかを伝える。 原因についての推測ではなく、目にした症状です。
  • 検索で見つかるようにする。 来月同じバグに遭遇した人は、いくつかの言葉で検索します。タイトルには、その人が使いそうな言葉を入れておきましょう。

うまくいく形

次の順番を試してください。まずどこで、次に何が起きたか、最後に重要な条件です。

`` チェックアウト:戻るボタンを使うとプロモーションコードが二重に適用される 書き出し:日付範囲が年をまたぐと CSV が空になる ログイン:モバイル Web でパスワード再設定後にエラー 500 が表示される ``

どのタイトルも、領域を示し、症状を述べ、そのバグを似たバグと区別する条件を1つ加えています。一覧をざっと見た開発者は、どれが自分の担当かを見分けられます。

損をするタイトル

| タイトル | 何が問題か | |---|---| | 「チェックアウトのバグ」 | 症状が書かれていません。チェックアウトに関するどのチケットにも当てはまります。 | | 「書き出しを直して」 | レポートではなくタスクです。原因を決めつけ、エビデンスを隠しています。 | | 「ボタンが動かない」 | どのボタンで、「動かない」とはどういう意味でしょうか? | | 「緊急!!! アプリが壊れた」 | 緊急度は優先度の欄に書くものです。また、「壊れた」は症状ではありません。 | | 「間欠的なクラッシュ」 | どこで?どんな条件で?いちばん近いチケットに統合されてしまいます。 |

推測ではなく症状を書く

「保存後にキャッシュがクリアされない」は推測です。「新しい価格を保存した後も古い価格が表示される」は、あなたが見たことです。推測が外れていた場合、タイトルに書いた推測は開発者を間違ったコードへと導きます。また、同じ症状を別の原因で見た人にとって、そのチケットは見つけにくくなります。自分の推測は、推測であると明記したうえで説明欄に書きましょう。

エラー文があれば入れる

製品がメッセージを表示したなら、その短い引用は、次の人に渡せる最高の検索語です。短くまとめ、ID、メールアドレス、個人に関わるものは省きます。「有効なカードで『card declined』と表示されて支払いに失敗する」なら、同じバグのチケットが見つかります。

登録する前にタイトルを試す

簡単な確認を2つ行います。

  1. タイトルだけを読む。 説明を隠してください。初めて見る人でも、どこで何がおかしいのかわかりますか?
  2. タイトルで検索する。 タイトルをトラッカーの検索欄に貼り付けます。以前のチケットが出てきたら、登録する前に読みます。存在するとわかっているチケットが見つからない場合、そのチケットのタイトルが弱いということです。あなたのタイトルにも、足りない言葉を加える必要があるかもしれません。検索そのものについては、バグを登録する前に重複を見つけるの記事で説明しています。

タイトルは一覧で読める程度の短さに保ち、詳細は説明欄に移します。何行にも折り返すタイトルは、たいてい説明を抱え込んでいます。

BugIt の出番

タイトルは、落ち着いているときには正しく書けても、急いでいるときには間違えがちです。大まかなメモで問題を BugIt に伝えると、この形のタイトルでレポートの下書きを作り、下書きをお見せする前にトラッカーから似たチケットを検索します。検索は読み取りのみです。下書きはあなたが確認し、必要ならタイトルを変更できます。BugIt は一般的な個人情報をベストエフォートでマスクします。FILE IT と入力するまで、トラッカーには何も書き込まれません。

仕組みは taskivator.com/bugit と bugit.dev でご覧いただけます。

まとめ

タイトルは一覧表示のために書きます。どこで、何が起きたか、そして重要な条件を1つ。見たことを書き、エラーがあれば引用し、登録する前に自分のタイトルで検索してください。

提供中AI アシスタント向け QA エージェント

BugIt

日本語