見出し画像

新卒でエンジニアになった頃に学んだ、報告の書き方

新卒で社会人になって以来、ソフトウェアのエンジニアをかれこれ10年近くやっています。そんな私が、新卒で入った会社の最初の配属先で、上司の上司に教えられた報告の書き方について紹介します。

報告には意味を書く

その人は「報告には意味を書くこと。」と常々言っていました。「ただ単にやったこと、起こったことを書いたものは"日記"。その意味を書かないとダメ。日記が許されるのは新人のうちだけ」だと。

ダメな例:「○○の設計はxx日に完了。現在は実装中。」

こういう週報を書くと、「これは日記だよ」と指摘されます。設計がxx日に完了したことが、チームやプロジェクトにとってどういう意味をもつのかが書かれていないからです。この報告は、例えば以下の様に改善できます。

改善した例:「○○の設計は、予定通りにxx日に完了。・・・」

これならば、「設計がxx日に完了 → これは予定通りである。順調である。」という意味が盛り込まれています。あるいはひょっとすると「○○の設計は、3日遅れのxx日に完了」なのかもしれないですよね。最初のダメな例では、そういう"意味"が読み取れない。報告を受ける人の視点からは「これは日記だ」「だから何?」となっちゃうんです。

ナッパもベジータに対して意味のない報告をしていた

唐突にドラゴンボールの例を引き合いに出しますが、アニメの中でナッパ(ベジータの部下)も同じミスをしています。

ナッパ「たった今フリーザ様より通信が入りまして何でも、惑星ベジータが消えちまったそうですぜ」
ベジータ「ほう・・・それで?」
ナッパ「原因は巨大な隕石が衝突したとかで・・・生き残ったサイヤ人は俺達を含むごくわずかだとか」
ベジータ「ふーん。それで?」
ナッパ「い、いや・・・別に。それだけです」

ベジータにとっては、自分達サイヤ人の故郷である惑星が消滅したことさえ、意味のない事象なのです。「ナッパが日記を提出してきた」ぐらいにしか思っていないのです。

※ なお実際は、惑星消滅の原因は隕石衝突ではなく、フリーザが破壊したというのが真実です。もしもナッパの報告が「惑星ベジータをフリーザが破壊した」だったら、ベジータにとっても意味のある報告だったかもしれません。

意味を書くには、一文書いてから「それで?」と自問する

私達がナッパにならないためには、報告には意味を書かなければいけません。当時の私はいつも、テキストエディタに報告を一文書いたあとに「それで?」と自問するように心がけていました。「○○をした。ので・・・?」と。つまりベジータの視点(報告を受ける人の視点)を想像するのです。

こうすると、更に付け加えるべき言葉が出てきたり、逆に「いやこれは報告する意味ないわ。消そ」と、ノイズを除去できるようになります。

私が新人だった当時、周りの先輩には「この週報は、日記だよ」と上司の上司に直々に指摘されている人もいました。上記のやり方をした結果、私は「日記だよ」を食らわずに済んでいます。

何が意味なのかは、相手によって変わる

同じ出来事に関する報告や連絡を、色んな種類の関係者にすることもあるでしょう。その時は「その人にとっての意味は何か」を考えることも大切になってきます。意味とは、報告をする側とされる側で共有されている文脈や前提知識だとか、お互いの役割や専門領域の違いなどによっても変わってくるからです。

例えば、ソフトウェアのバグ修正をしていたとします。同じプロジェクトで一緒に実装しているエンジニア同士ならば、「何番のプルリクをマージしといたよ」でも十分かもしれません。

これが、QA担当者が相手だと「バグ修正のプルリクがさっきマージされました。なので、明日の朝には修正版の動作確認ができる状態になっているはずです」になるかもしれません。

はたまた、より上位の人への報告なら「テスト実施の阻害要因となるバグがありましたが、解消される見込みです。よって、何月何日にリリースするという当初の予定はキープできそうです」というのもあり得そうです。

報告には簡潔さも大事

なお、相手によっては「テスト実施を阻害要因となるバグが・・・」のくだりは余計である可能性もあります。「そういう事はいいから、間に合うのかどうかだけが知りたい。どうやって間に合わせるかは、あなたの専門(or 責任)」ということもありますから。

報告は詳しければ良いとも限らず、簡潔であることも大事です。このあたりのバランスは難しいところです。

まとめ

報告には意味を書くことが大切という、当時いた会社の上司の上司からの教えでした。私も含め、ずらずらと「日記」を報告することはついやってしまいがちです。今一度、「それで?」と自問する癖をつけてはいかがでしょうか。

エンジニアの仕事でいうと、GitHubのIssueやプルリクの説明文、あるいはコミットメッセージなども、報告を書く欄と捉えられるのではないでしょうか。そのように考えると、私が当時いた会社のように「全員が毎週、かっちりした週報を提出する」といった環境でなくても、報告を書く場面はきっとあるはずです。そして、報告を書くスキルは多くの人にとって必要となるはずです。

この記事が気に入ったら、サポートをしてみませんか?
気軽にクリエイターの支援と、記事のオススメができます!
72
CureAppで色々やっているエンジニアリングマネージャーです。 https://cureapp.co.jp/engineers.html