社内向け不具合報告ガイドを公開する

2020/05/15

最近、株式会社10Xでは採用の拡大を始めた。これから迎えるであろう新しいメンバー達が余計な戸惑いを感じないように、これまで暗黙知になっていた諸々をガイドとして明文化しようとしている。まず手始めとして不具合報告ガイドをつくったので、これを公開してみる。社外の意見も聞いて、ガイドを改善できたら嬉しい。

不具合報告ガイドの作成に当たって意識したのは、不具合を報告する人の責務を最小化することだ。不具合を報告してくれる人全員が開発の事情について詳しい訳ではないし、重複イシューがないかチェックしろとか、ラベルを付けろとか、そういうことは要求しない。不具合を報告することだけが報告者の役割であり、それを整理するのは開発チームの仕事だと考えている。

不具合報告ガイド

アプリなどに不具合らしきものが見つかった場合、開発チームに共有してください。

手順

  1. GitHubのイシューにアクセスする。
  2. 「New issue」をクリックして、以下の内容を含めたイシューを作成してください。
    • どんな不具合が起きたか
    • 不具合が起きた手順
    • 不具合が起きた環境
      • 本番環境か開発環境か
      • アプリのバージョン (例: 1.0.0 (123))
  3. 緊急性がある場合、Slackの #dev にイシューのリンクを貼って連絡してください。

報告されたイシューは開発チームが定期的にチェックして、開発マイルストーンに乗せます。

心得

不具合らしきものを見つけたら、まずはイシューを作成しましょう。

  • 事前にSlackなどでエンジニアに相談する必要はありません。
  • 既存のイシューとの重複は気にする必要はありません。

以下のような心配をして、イシューの作成を躊躇しないでください。

  • 実は不具合ではなくて自分の勘違いじゃないか。
  • もう既に把握されている不具合なんじゃないか。
  • いきなりイシューをつくるのは失礼にならないか。

イシューの作成を躊躇して欲しくないのは、不具合の管理を確実にするためです。Slackなどで事前相談をすると、作り忘れることがあり、結果的には修正漏れの原因になります。とにかく、まずはイシューを作成してください。イシューさえ作成してくれれば、あとは開発チームが整理して、解決します。