僕は普段から社内文章に関して思うことがいろいろある。そこで見つけた以下の記事。
読まれないマニュアルに価値はない | サイボウズ式
http://cybozushiki.cybozu.co.jp/articles/m000338.html
これは社内の業務マニュアルについて言及した記事だけど、共感する点は多かった。
以下に気になった箇所を引用しておく。
マニュアルづくりに時間をかけすぎてはいけない
その上で、マニュアルをつくる際にはあまり時間をかけすぎてはいけません。
マニュアルはあくまでチーム内で使うものですから、顧客に出すもののように綺麗にデザインなどを入れる必要はありません。文章を書くのに時間がかかるなら、箇条書きのようなものでもよいのです。
また、リンクで済むものは極力リンクで済ませるべきです。他所にも書いてあるものを、二重で書くのは時間のムダです（参照先が消えるおそれがある、などであれば別）。たとえば、これはエンジニア限定の話ですが、コードを読めばそれで読み取れるという情報をわざわざ文章にして再記述する必要はありません。マニュアルを書く手間は、少なければ少ないほどよいのです。
マニュアルに限らないが、社内文章をキレイに作りすぎる。時間をかけずにキレイに出来ればそれに越したことは無いけど、キレイに作ろうと意識するほど時間が掛かる。他愛もないメモならメールにプレーンテキストで直打ちで用は足りるのに、わざわざワードで作成してPDFで出力してメールに添付という回りくどいことをしている人もよく見かける。そんな時間があるのならコードを書け。
まずは自分の作業メモからはじめよう
マニュアルは別途時間を確保してつくるのではなく、実際に業務をしながらつくってしまうのがおすすめです。具体的には、「作業メモ」を取りながら仕事を進め、そのメモをそのままマニュアルにしてしまうわけです。このやり方なら、忙しさに関係なくマニュアルが蓄積されていきます。
これは後任者のためだけでなく、自分のためにもなります。メモという形で自分の業務を整理することで、新しい気づきが得られるかもしれません。
作業メモは時として非常に役に立つ。ソフトの設定や例外処理の手順など、日常的なことなら頭に入っていて当然のことでも、数ヶ月あるいは数年に１度しか行わない作業だと忘れて当然。備忘録として簡単なメモでも残しておくことで、ゼロから調べながら作業する必要が無くなりジャンプスタートできるようになる。Evernoteなどを使っていろんなメモを書き溜めておくとよい。
読まれないマニュアルに価値はない
あたりまえですが、マニュアルには必ず「読者」がいます。自分の作業メモをそのままマニュアルにする場合であっても、読者として未来の自分がいます。デザインや形式にこだわる必要はないものの、最低限読者に通じるような書き方をする気持ちは持たなければなりません。
誰にも読まれないマニュアルを書くことは、完全に時間のムダです。あとで読む人がいるから、書く意味があるのです。そのことを忘れてはいけません。
文書化する目的について、書いている本人が理解していない場合が多い。ではなぜ書くか？上司がそう指示してきたからとか、社内ルールでそう決まっているからとか。文書化する目的をきちんと理解することで、誰に何を理解させたいのかが明確になり、読んでもらうための配慮が自然となされるものになるだろうと思う。文書化する目的が見えないならば文書化する必要は無い。時間の無駄だ。