バグレポートを英語圏の開発者に初めて出す時の5つのポイント

2013.12.17 スキル

IT用語はアメリカ発の言葉がほとんど。でもいざ英語で書こうとすると「何と書いたらいいのか分からない……」という時もあるはず。そこで“コピペでOK”なIT英語表現を紹介！

開発中に発見したバグを同僚に報告したり、デベロッパーサイトからバグレポートを提出したりした経験は多くの開発者があるだろう。が、開発が日本人だけのチームならレポートも日本語で構わないが、英語圏のメンバーがいる場合やOSSプロジェクトなどであれば、英語で報告しなければならないシチュエーションも出てくる。

今回は、シンガポールで働くエンジニアのDさんに、英語でバグレポートを書く際に気をつけるべきポイントや心構えなどについて教えてもらった。

Dさんに聞く、バグレポートの基本

バグ報告は、開発者にバグの存在を認識してもらい対処を促すことが目的だ。

もし目の前でバグを再現してみせることができるなら、これに優る伝え方はない。しかし開発者が遠隔地にいる場合にはそれができない。だからこそ不具合の内容を書式化して報告するバグレポートが必要になるのだが、発生している現象をただ書き連ねるだけでは、開発者にバグの存在がうまく伝わらないことも多い。

「I need more information.」（情報が足りません）、「I can’t reproduce the error.」（エラーが再現できません）と言われて何度もやり取りを繰り返すことを避けるためにも、具体性と端的さが必要になってくる。

バグレポートのまとめ方

大方の企業では、バグレポートのフォーマットがあらかじめ用意されているだろう。基本的には日本語でも英語でも伝えるべきポイントは変わらないが、しかし最初から作るのであれば、下記の5項目でまとめるとよい。

【1】バグを説明する端的な説明文（Description）

1～2文程度で端的に現象をまとめるとよい。

（例）When creating a new user, application crashes on clicking the SAVE button.
（訳）新規ユーザーを作成する際に、セーブボタンを押したらアプリケーションがクラッシュします。

※NG例
・○○○（プログラム名など） has a serious bug.　（訳）○○○には重大なバグがあります。

・○○○（プログラム名など） can’t work.　（訳）○○○は動きません。

・Software crashed.　（訳）ソフトウエアがクラッシュしました。

これだけの情報では、バグの内容が漠然としていて伝わらず、単なるクレームになりかねない。具体的に「何がどうなっているのか」を書くことが大切になる。

【2】再現手順（Steps to reproduce）

下記のように箇条書きでまとめると伝わりやすい。動詞で書き始めるのが一般的。

（例）［Steps to reproduce］
1) Logon into the application
2) Click the ‘New User’ button
3) Fill all the fields
4) Click on ‘Save’ button

（訳）［再現手順］
1）アプリケーションにログオンする
2）「New User」ボタンをクリックする
3）項目を埋める
4）「Save」ボタンをクリック

何を指しているかが分かるように、「それ」（it）や「その」（the）、「これ」（this）といった代名詞は極力避けるのが無難だ。

【3】想定していた結果（Expected Behavior (Result)）

端的に1文程度でまとめる。

（例）After clicking on ‘Save’ button, I expected to see a success message “New User has been created successfully”.
（訳）「Save」ボタンを押した後、「新規ユーザー作成に成功しました」というメッセージを表示されることを期待していた。

【4】実際の結果（Actual Behavior (Result)）

【3】と同様に、端的に1文程度でまとめる。

（例）I saw an error page as attached. Please refer to the following error code as well.
（訳）添付のようなエラーページが見られた。以下のエラーコードも参照してください。

「I saw an error page……」と文章で書いた上で、スクリーンショットやエラーコードを添付した方が、よりエラーの状況が伝わりやすくなる。

【5】操作環境（Operating System）

バグが発生したビルドやOSや関連ソフトウエアのバージョンなども伝える。

（例） Windows 8.1, Mac OS X, Internet Explorer 10, Safari6.1

これ併せて、バグの重要度や再現頻度、以前のビルドで発生したかどうかなども記載しておくとより良い。

これまで「英語のバグレポートを送るのはちょっと……」と思っていた人も、ぜひ上記を参考にして英語でのバグレポート作成にチャレンジしていただきたい。

ちなみにDさんは、「もし英語が得意でなければ、英語で書く前に、まず日本語で書いてみることをすすめる」と言う。日本語で相手に伝わらないレポートなら、英語に直しても伝わらない可能性が高いからだ。

まず、日本語でバグレポートを書き、まったく事情を知らない相手が読んでも同じ手順でバグを再現できるかどうかを確認してから、上記の記述を参考に英訳をしてみよう。

多少手間が掛かっても、伝達度が上がるはずだ。