課題を記載する際に意識していること

本投稿は TECOTEC Advent Calendar 2023 の13日目の記事です。

こんにちは。決済認証システム開発事業部の當間です。

エンジニアならGithubのissueやBacklogのタスク、Redmineのチケットといった
いわゆる課題を登録することってありますよね。
(本記事では課題で統一します。)

ただ、自分が登録した課題はもちろん、他の人が登録した課題でも、
課題を見ても何をすればいいのかわからないことってありませんか?

最近この辺りで頭を悩ませることが多かったので、 本記事では私が気を付けている課題の記載方法を紹介します

読み手は誰か?

まずは心構え的な部分になりますが、これが一番大事なことだと思っています。

自分は誰に向けて課題を書いているのか
社内向けなのか、社外向けなのか
開発者向けなのか、顧客向けなのか

読み手が誰なのかによって、前提知識や使用する言葉、記載の細かさが変わってきます。 課題を書く際はまずこれを考えるようにしています。

事象、問題、リスク、課題、タスク

自分が登録した課題に対して、「つまりどういうこと?」と言われたことはないでしょうか。 私はかなりあります。

そこで以前教えてもらったのが、以下5つの考え方です。

  • 事象
    • 既に起きたこと
    • これから起きること
  • 問題
    • 既に発生した事象の原因で、今対応が必要になること、
  • リスク
    • 今後発生が予想される事象の原因で、今後対応が必要になること
  • 課題
    • 問題orリスクを解消するための対応内容
  • タスク
    • 課題の対応内容に対する具体的な作業

課題の記載方法やフォーマットはPJによって異なりますが
そのようなルールがいくら細かく決まっていても、やはり書き手自身がちゃんと理解した上で書かなければ伝わるものも伝わりません。

この5つを整理してから課題を記載することで 読み手の負荷を下げ、読んでもらえる課題になるよう心掛けています。

使うときに気を付けている言葉

課題を記載するなら、そのゴールを明確にしておくべきです。 ただし、明確であるにもかかわらずちょっとした言葉遣いで伝わらないこともあります。

自分が課題を記載するときに特に気を付けている言葉を紹介します。

「確認する」「相談する」

便利なのでよく使ってしまいがちです。 使う場合、確認した後に何をどうするのか?というところまで書きましょう。

「問題ないか?」「~ではないか?」

これを書かれた相手の気持ちになりましょう。
「そんなこと言われても・・・」「だったら何なの?」となりませんか?

このようなことを相手に聞きたい場合は以下3点を明確にしましょう。

  • 問題なしと考える理由
  • 了承を得る相手
  • 了承してもらった後の具体的な作業

「~について。」

これも便利な言葉ですが、「~について。」で記載が終わってる課題が稀にあります。
特に課題タイトルに使われていると、「それがどうしたんだ?」とタイトルから中身が推測できません。

これを使いたくなった場合は、
○○について「どうする」のか? ということまで書くようにしましょう。

さいごに

自分が課題の登録時に気を付けていることを紹介しました。

課題には当然期限というものが設定されます。
余裕があるときはもちろん、切羽詰まっている時こそこういう部分を意識し、 読み手の時間を奪わないようにしたいものです。

エンジニアであれば課題やタスクを登録する機会は必ずありますので、その際の一助にでもなれれば幸いです。

テコテックの採用活動について

テコテックでは新卒採用、中途採用共に積極的に募集をしています。
採用サイトにて会社の雰囲気や福利厚生、募集内容をご確認いただけます。
ご興味を持っていただけましたら是非ご覧ください。

tecotec.co.jp