目的
はじめての人でも楽しく効果的にデバッグ作業を行えるよう、その手順を整理したものです。
一時的にプロジェクトに参加する人を想定して、個々の作業の最適化よりも、ルールと導入の簡易さを優先して設計しました。
準備
ツール
ソフトウェアは、Win版かMac版のGoogle Chromeを使用します。
ウェブサービス、Trelloというウェブサービスを使用します。
- アカウントを作成する
- アカウント名を開発担当者に教える
- 開発者からデバッグ専用のTrelloボードが共有される
以下のプラグインをGoogle Chromeにインストールしてください。
| Trello Card Numbers | チケットに番号が付与され議論しやすくなる |
| CardCounter For Trello with Totalizer | チケットの数が表示され量を把握しやすくなる |
<編集中>
trelloボード上でラベルをクリックすることにより、文字を表示されることが出来ます。
絵 befor + after
</編集中>
ROMの取得と実行
ROMとは本来は (Read Only Memory) の略ですが慣習で、
実機 (携帯端末やコンソール機) にインストールすれば、
そのまま動作する1つのファイルを指します。
開発者から以下のものが案内されます。不足の場合は開発者に指摘してください。
- デバッグで使用するROMの実行環境
- 例：iPhone, Android, Nintendo Switch, ノートPC等
- PC版の場合は、デバッグ作業者のPCでの実行をお願いすることもある
- 最新のROMがダウンロードできる環境
- TrelloのチケットにURLを記載する予定
- ROMを実機にインストールし、起動するかどうか確認する
- 開発資料の共有
- デバッグキーがまとまった資料
- 基本操作がまとまった資料
- Trelloのチケットに記載をする予定
- 連絡手段
- 例：Slack, Chatwork, Line, メーリングリスト等
- Trelloのチケットのコメント機能を活用する予定
作業フロー
デバッグ作業は、２名体制で２日〜５日行うことを想定しています。
仮説フェーズ
まずは実際にゲームを一通り遊んでみて、全体の仕様を把握します。どこで不具合が発生しやすそうなのかを話し合って、検証する項目をリストアップします。通常は１日で行います。検証フェーズの状況を見て、再度、仮説フェーズを行うこともあります。
検証フェーズ
自分たちでリストアップした項目について、不具合が起きないか確認をします。見つかった場合は不具合を報告し、開発者に修正してもらいます。（１〜２日くらい掛かります）修正後、それを改めて確認し、問題がなければ完了です。
修正後、勘違いで直っていないのに修正済みにしたり、
報告の意味を取り違って別の修正をしたり、
修正により別の場所で不具合が発生することが多々ありますので、
しっかり確認しましょう
バグブレストについて
最低２名で、ゲームのどの箇所にバグが潜んでいるか、ブレストを行いましょう。
典型的なバグをまとめました。ブレストのヒントにしてください。
| グラフィック | 地形のグラフィックの一部が欠けている |
| シーケンス | 倒したはずの敵がまた出てきた |
| シーケンス | 先に進むためのアイテムが途中で紛失し、進行不能になる |
| シーケンス | メニューで選択したステージと別のステージに入る |
| テキスト | キャラクターのセリフに誤字脱字がある |
| テキスト | 言語を英語にすると、一部の吹き出しに文字が収まらない |
| システム | たくさんの敵が出てきたときに処理速度が落ちる |
| システム | 画面の２つのボタンを同時に押すと、画面がフリーズする |
| システム | 何度もリスタートすると画面がフリーズする |
| サウンド | BGMが切り替わる瞬間にブツッというノイズが混じる |
| 保存 | セーブ中に電源を切ると、セーブデータが破壊されている |
| 端末 | ゲーム中に通知機能が出てきた場合、強制終了される |
優先的に修正すべきバグ
ゲームが止まったりクリアができないなど進行不能になるバグは通称「Aバグ」とし優先度を高くして修正します。それ以外は「Bバグ」とします。
チケットの運用術
全体の流れ
trelloの作業フローは基本として左から右に流れていきます。
※ 「連絡」等、例外もあります。
各、列（横）により状態が分けられ、それぞれにチケットが収まります。
| 連絡 | 全ての人 | ROMの受け渡しや、連絡用チケット |
| 調査リスト | デバッグ作業者 | バグブレストで出た調査すべき項目 |
| 新規発見 | デバッグ作業者 | 調査リストに基づき発見した新しい不具合 |
| 修正済（ROM反映待ち） | 開発者 | 不具合を修正した場合はこちら |
| 確認依頼 | 開発者 | 当日のROMに反映され確認可能な状態 |
| 再発 | デバッグ作業者 |
不具合が直っていなかった場合 ＝＞修正出来たら、修正済（ROM反映待ち）へ |
| 完了 | デバッグ作業者 | 修正がされていた |
| 保留 | 開発者 | そもそも不具合でなく仕様であったり、修正が困難な場合 |
サンプルとして公開ボードを作成しました
検証項目のリストアップ
- ゲームのシーンごとにチケットを分けます。シーンの区分が分からない場合は、開発者に聞いてみてください。
- リストアップした日毎にチェックリストを作り、検証すべき内容を記述します。検証が終わったらチェックをします。
不具合報告
- ２０字程度で概要を書きます。
- 「説明」により詳しい情報を書きます。
- 詳細：どこで、何をしたら、何が起こったのか
- 手順：開発者が再現するための、おすすめの手順
- 頻度：毎回発生するのか、たまにしか起こらないのか
- 環境：使っている端末と、確認したROMのバージョン
- 不具合の種類によっては、画面のスクリーンショットがあると、理解の助けになります。
画面の撮影に関して
共有のスマートフォンを提供します。
端末にはtrelloのアプリがインストールされておりtrelloボードにアクセスできるようになっていますので、ゲーム画面を端末のカメラで撮影し、該当のチケットに添付をしてください。
連絡用チケット
- ２０字程度で概要を書きます。
- 「説明」により詳しい情報を書きます。
更新情報
- 2020/02/20 初稿