2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

報告するなら知っておきたい「テクニカルライティング」の知識

Posted at

定例MTGや日報、週報などの「誰かに現状や進捗を報告する」という場面は、さまざまな規模で頻繁に発生します。

あるいは誰かに報告はせずとも、書きなぐりのメモのような、明日の自分に向けて報告することもあるでしょう。

口頭であれ文章であれこのような報告が上手くなると、他者1への情報共有がスムーズになりますし、自身の頭の中もスッキリします。

この記事では『成果を生み出すテクニカルライティング2が提唱する「黄金フォーマット」を、できるだけ短く伝えてみようと思います。

黄金フォーマットは「背景・前提」、「課題」、「アプローチ」、「結論」の4項目を準備する

テクニカルライティングにおけるフォーマットは、

  • 背景・前提
  • 課題
  • アプローチ
  • 結論

の4つを満たすことが必要となります。

以下ではすべてに簡単な説明を加えますが、私がとくに重要だと感じるのは前半の「背景・前提」と「課題」です。

「背景・前提」をふくめる

背景・前提とは「過去どうなっていたのか」や「これまでどのように進んできたのか」という情報です。

報告が「TODOリストの状況説明」になっている場合、おそらく背景や前提が抜けています。

これが存在しないと、そもそも「なぜそのタスクを実行した(している)のか」「解決しようとしている課題は的を得ているのか」が判断できません。

「背景・前提」から「課題」をとりあげる

課題とは、上述の背景・前提から導き出せる情報です。

背景・前提があれば、自然と「次は〜が大事な作業になると考えていた」とか「しかし〜は予想と異なったため、別途調査が必要だった」など、課題を記述できます。

ここで大事なのは、ただ課題だけが書かれているだけと違って背景・前提があると、あなた以外の他者にもその課題を共感・納得してもらえる、ということです。

自分のやっている仕事の難しさが伝わってない!」と感じる場合も同様で、それは課題の説明が不足しているのではなく背景・前提の共有が不足している可能性が高いでしょう。

「アプローチ」にくわえて「結論」を用意する

背景・前提と課題があれば、いよいよ何をやったか=アプローチを説明できます。

このタイミングで、挙げた課題をするためにもしくはプロジェクトを前へ進めるために何を実施したのか説明すると、他者にもとてもよく伝わります。

最後に結論も準備します。これは「課題は解決したのか」や「背景に書かれたいた状況からどう変わったのか」さらには「よって次はどうするのか」など、アプローチを実践したことで現状どんな結果が得られたのかを指しています。

ここまで書けると、報告したい本質的な内容を他者が理解でき、その後の相談や提案などのコミュニケーションもよりスムーズになります。

「何をしたの?」より「どんな状況だったの?」が重要

テクニカルライティングのフォーマットをできるだけ簡潔に紹介してみました。

それでも「やることが多い......!」と悲観的に感じる方もいるかもしれません。

そんな方に伝えたいのは、「もともとどんな状況だったの?」ってことから説明してみましょう、ということです。つまり前提をちゃんと書きましょう、ということですね。

これをやるだけで他の要素もおのずと埋まることが多いはずです。

言い方を変えれば、「やったことを最初に伝える」ことから脱却すると、一気にそれらしくなる。というのが私の実感です。

さいごに

正直、ちゃんと真面目に報告するだけでも素晴らしいとは思います。そのうえでこのフォーマットを意識してみると、さらに質の高い報告になるはずです。

今回は簡単な紹介だけでしたが、リアクションがあれば別の記事で実践編も書いてみようかと思います。

ぜひ気になる点や実際に困っている点などあればコメントいただけると幸いです。

  1. 「明日の自分の他者である」というのが筆者の認識です。 実は重要な考えだと思いますのでここに残しておきます。

  2. 藤田肇『成果を生み出すテクニカルライティング ── トップエンジニア・研究者が実践する思考整理法』

2
3
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?