【実践編】ドキュメントをわかりやすく書くためにおさえるべきポイントとは!?

July 19, 2018
活用方法 | Tips

こんにちは!CSチーム岡上です。

今、みなさんはどのようにして、ドキュメント(文章)を書いていますか? 以前、【入門編】ドキュメントをわかりやすく書くためにおさえるべきポイントとは!? をご紹介しましたが、今回は実践編です。以前の振り返りを行うと、ポイントは3つでした。

「結論から共有する」

「5W1Hを意識する」

「短くシンプルに伝える」

実践編では…

3つのポイントを意識すると文章がどのように伝わりやすくなるか、実際のトピック本文を用いて解説します。また、誰でも簡単にわかりやすくトピックが書ける「テンプレート」も、あわせてご紹介します!

わかりにくいドキュメントで、上司にいつも指導されてしまう…

まずは3つポイントを意識しないで書いたトピックをご覧ください。

はい…

このドキュメントを読んでみて、どう思いましたか?正直読みにくかったと思います。

プログのオペレーションを決めたいのはわかるけど… 読んだ人はこの後どうすればいいのか、困惑してしまうでしょうね。おそらく、このトピックを作成した後は、上司からのコメントで「ちょっと、あとで直接話そうか?」と呼び出され、結局すべて口頭で説明することになるでしょう…

このようなトピックを作成しないためにも、【入門編】ドキュメントをわかりやすく書くためにおさえるべきポイントとは!? でお伝えした3つのポイントをおさえたトピックに作り変えます。

もう、わかりにくいドキュメントとは言わせない!

先程のトピックを私たちが普段使っている、「テンプレート」に当て込んで修正してみました。

ポイントをおさえたテンプレート

テンプレートを活用し、3つのポイントを意識して修正‍

※TBDとは…要決定/未決定、要完了/未完了、要検討/未検討という意味合いで使用しています。

いかがでしょうか?先程のトピックと違って、読みやすいことが一目瞭然でわかりますね。短くシンプルで、要点が整理されており、読み手が理解しやすいトピックとなりました。続いて、1つ1つ見出しごとに解説していきますね!

今回のトピックを見出しごとに理解し、上司を見返そう!

YKPAKU7023_TP_V.jpg

①これは何? 〜結論から共有する重要性〜

「これは何?」は結論です。タイトルでも「ブログのオペレーションについて」と書いています、しかし、「ブログのオペレーションについて」を誰とどうしたいのか、ということが読み手は伝わらないので、ここでは「誰」ということを明確にしています。

②「課題・背景」〜Whyを追求〜

「課題・背景」はWhyを追求しています。結論に対して、なぜ決めなければいけないのか?なぜいまなのか?ということを、現在とこれからを比較して書いています。ただ、背景について、場合によってはわざわざ背景を書かない方が複雑にならず、伝わりやすい場合もあるかと思います。そのあたりは書きながら慣れていきましょう。

③「目的・ゴール」〜Whatを明確に〜

「目的・ゴール」はWhatを書く部分になります。今回のトピックの場合、ブログのオペレーションを決めることが今回のゴールです。そして、オペレーションを決めた目的はブログを定期的に更新するということです。また、「目的・ゴール」を定めることで、その後の「解決方法」もぶれにくくになります。

④「解決方法」〜Howで解決〜

「解決方法」はHowの部分に当てはまります。どのようにしてその「目的・ゴール」を達成するのか、どのようにして解決するのかという手段を書いています。今回は各チームごとに運用が違うため、それぞれのチームのオペレーションを決めることが解決方法となります。まだ解決方法がまで考えられていない場合、TBDとしておき、今後トピックで議論すれば大丈夫です。

⑤自分からコメントする 〜意見をもらうには自分からの発言が重要〜

最後にトピックを書き終えてから、コメントを書くことで読み手に念押しすることができ、反応をもらいやすくなります! また、最初にコメントをするという行為は、少なからず抵抗があるものです。そのため自分からコメントすることで読む側がコメントしやすい環境をつくります。

⑥補足

今回ご紹介したトピックの場合、5W1HのWhereとWhenの部分は書いておりません。会議で決定するものや具体的な「期日・スケジュール」などが決まっていれば記載しますが、今回は当てはまらないので書いていません。無理に書くことで読み手の理解度を下げてしまう可能性もあります。伝えるべきことだけを伝えるようにして、必要に応じて書き足していくことが大切です。

最後に

いかがでしたでしょうか?

テンプレートを活用し、3つのポイントを意識して書くことで、ドキュメントをわかりやすく、そして早く書くことができます。最初は難しく感じるかもしれませんが、日々意識して書いていくことで、それが習慣づいていきます。また、トピックは何度も編集できますし、わかりにくいと言われば何度も修正してわかりやすくしていけば大丈夫です。まずは、ご紹介したトピックの見出しでテンプレートを作成し、当てはめて練習をしていくことで、少しずつドキュメントを書くことへの苦手意識を解消させていきましょう!

Related Posts

料金・資料請求・ご質問など、お気軽にお問い合わせください