チームメンバーの時間を有効活用できるようにバグ報告用の issue テンプレートを作りました

この記事は Gaji-Labo Advent Calendar 2019 25日目の記事です。

おはようございます。Gaji-Labo 鈴木です。
先日書いた、 バグレポートがうまくできず戸惑った経験から学んだこと の最後に、Gaji-Labo の社内プロジェクトにバグ報告用の issue テンプレートを作った話を少しだけしました。

今日はそのことについて書いていきます。

なんで欲しいと思ったか

Gaji-Labo の社内プロジェクトは2週に1度ミーティングしています。
その時に issue の内容、それらに紐づく作業内容を参加者全員で確認していたのですが、メンバーそれぞれに案件があるので、ミーティングの時間を少しでも短くして効率化したいと考えました。

また、issue だけで完結できるものはコミュニケーションとらずともどんどん進められると、プロジェクトの進捗にも良い影響が出るのではないかと思いました。

コミュニケーションがコストなのでやめよう、という話ではなく、みんなの時間を有効活用できたらいいなと思ったのがきっかけです。

テンプレートを作るときに気をつけたこと

issue を立ててくれる人の負担を増やしたくないので、不要であればゴソっと削除しやすいフォーマットになるよう気をつけました。

ポイントは [タスク] すでに解決方法など把握している場合は、タスクとしてやるべきことを記入してください の部分です。

起票する人が、「大体目処は立っていて、あとはやるだけなんだよね」という状態で issue を作る時もあります。
そういった issue を後から他のメンバーが見ても、作業できるようになっていると良いなと思いました。

以下が実際に用意した issue テンプレートです。

できる範囲で記入してください 🖋

## バグが何であるかの明確で簡潔な説明
💁‍♀️ スクリーンショットや GIF があったら貼ってください

– 当該URL:

## 再現する手順

動作を再現する手順：
1.

## 期待される挙動

## タスク
💁‍♀️ すでに解決方法など把握している場合は、タスクとしてやるべきことを記入してください

## 備考・その他

## Desktop
– OS:
– Browser:

## Smartphone
– Device:
– OS:
– Browser:

所感

issue 内に最低限必要な情報が揃うことで、読んだ時に「何が問題でどうあるべきか」が分かりやすくなったと思います。

今回はメンバーの時間を有効活用するために、 issue テンプレートを作るという手法を選びましたが、今後もメンバーが気持ちよく仕事できるように少しづつ改善していきたいと思います。