これは ソフトウェアテストの小ネタ - Qiita Advent Calendar 2024 - Qiita 8日目の記事です。
「がっつり記事を書くほどではないけれど・・・」
と書いてくださっているので、小ネタでハードルを下げてみます。
不具合報告書のタイトル(サマリ)に使わない表現についてです。
組織で受け継がれているルール、各個人が良いと思って運用しているルールがあると思うので、それらを否定するものではなく、
あくまで私基準のマイルールであることを前提に読んでいただけると嬉しいです。
不具合報告書のタイトルは限られた文字数で、簡潔に事象を伝えることが重要です。
句読点(。 、)はできるだけ使わない
限られた文字数で伝えるという目的から、1文字でもタイトルが短い方が文字数比での情報量を増やすことができます。
そのため、句読点はできるだけ使わないようにしています。
句点についてですが、1つの不具合報告書に対して1つの事象を記述するという前提を考慮すると、句点 。 が必要な場面はないと考えています。
読点 、 をつけたくなる場面はたびたびあり「〜のとき、」「〜の際、」「〜すると、」などの後ろに読点を付けたくなってしまいますが、
読点をつけなくても意味が通じる場合は削除するようにしています。
「〜がおかしい」
「どうおかしいの？」と心の中でツッコミを入れたくなってしまう表現です。
仕様と異なるふるまいだからおかしいと感じたのか、本来あるべきレイアウトになっていないからおかしいと感じたのか、
「おかしさ」を具体化して表現することが重要だと考えています。
「不正」
「表示が不正」「不正に〜している」などの表現をしばしば目にすることがあります。
正しいふるまいをしているのであれば、本来不具合報告書は起票しないはずなので、「不正」という単語を入れる必要はないと考えています。
前述の「おかしい」と同様、「不正」と感じた事象を具体化すると、「不正」という単語を使わなくても表現できるのではないでしょうか。
おわりに
不具合報告書の簡潔さという視点で書いてみました。
しかしながら、簡潔さと同時に不具合の情報を素早く関係者に伝えることも重要なので、
推敲の時間と簡潔さのバランスを意識した上で、起票者の主観で第三者が読んで伝わることを目指したタイトルになっていれば、それで良いと思います。
