ドキュメンテーションについてまとめ

マネジメントをやり始めて劇的に文章を書く機会が増えた。

そして自分には読みやすい文章を各能力が破滅的にないことを思い知った。

ということでドキュメンテーションに関する本を読んできたのでまとめておく。

自分への備忘録ではあるが、同じように文章を書いてもうまく伝えられなくて悩んでいる人の助けになってくれれば嬉しい。

 

目的を意識する

いきなり結論になってしまうが、1番大切なことは目的を意識することである。

誰に何を伝えたいのか、を常に頭に置く。

例えば同じ内容を書くにしても自分の上司に向けた場合とお客様に向けた場合では使う用語を変えるとかって考えるとイメージがつきやすいかもしれない。

 

構成を意識する

読者が誰であれ、どういう内容を書くのであれ、実はわかりやすい文章には共通点がある。

結論→詳細→まとめ、が鉄板のフォーマットだ。

よく結論から話せって言うのは見聞きするが文章でも同様らしい。

あなたにこれを伝えたいのです→それはこういうことです→ということでこれを伝えました、という感じだろうか。

確かにわかりやすい気がする。

もし文章が読みづらいと指摘されたときは構成を意識してみると良いかもしれない。

 

論理的に書く

論理的、というとどういうこと?となるかもしれないのでもう少し具体的に言うと

感情を乗せず事実を書くということになる。

例えば提案書に「私はやったほうが良いと思います」というのは要らない。

実際はそうだとしてもこれだと「それってあなたの感想ですよね」で終わってしまう。

どうすればよいかと言うと「私はすべきだと考える。なぜならば」を書く。

この"なぜならば"も個人の感想ではなく事実ベースの理由、例えば過去事例で◯%の売上増があった、などを書く。

事実がないなら仮説でもよくて、その説明をすればよい。

 

必要なことは全て書く

先ほどの論理的な文章では余計なこと(感情)は書かない、だったがこちらは逆だ。

これは個人的によくやってしまうのだが、書かなくてもわかるだろうとか伝わるはずと必要なことを省略してしまうとまぁ人には通じない。

何ならそれを無意識でやってしまっているので何とも悩ましい。

これに関してはもうとにかく書く量を増やすしかない。

最初は意識して丁寧すぎるくらい丁寧に書いて、だんだん削れる所があれば削る。

 

まとめ

細かいテクニックみたいなものはまだまだいっぱいあったがきりが無いので一旦主要そうなところだけをまとめた。

もしテクニック的なところも知りたいとかもっと詳細が知りたい人は最後に参考書籍を載せておくので読んでもらえればありがたい。

個人的にはやはり最初に書いた目的を意識することがすごく大事だと感じた。

書き始めるときはおそらく誰だってしているはずだが、書いているうち、直しているうちにだんだん伝えることが目的ではなくきれいに書くことが目的にすり替わっていたりというのは心当たりがないだろうか。私にはある。

その結果できあがるのは何かまとまってるっぽいけど、よくわからないドキュメントだ。

わかりやすい文章を書けるようになるには場数を踏むしかない。

なのでこれからもインプットした知識をこうしてブログにまとめていく。