読まれないマニュアルに価値はない：サイボウズ式（2/2 ページ）

[サイボウズ式]

マニュアルづくりに時間をかけない

　その上で、マニュアルをつくる際にはあまり時間をかけ過ぎてはいけません。

　チーム内で使うマニュアルは、顧客に出すもののようにきれいにデザインをする必要などはありません。文章を書くのに時間がかかるなら、箇条書きでもよいのです。

　また、リンクで済むものは極力リンクで済ませるべきです。ほかのところに書いてあるものを、重複して書くのは時間のムダです（参照先が消える恐れがある場合などは別）。例えば、エンジニア限定の話ですが、コードが読めば読み取れるような情報をわざわざ文章にして再記述する必要はありません。マニュアルを書く手間は、少なければ少ないほどよいのです。

自分の作業メモから始めよう

　「引き継ぎで困らないようにマニュアルを準備しよう」という気持ちで自ら進んで「マニュアルづくり」の時間を確保できる人は稀です。「仕事が暇なときに」と思ったとしても、少しでも忙しくなると、「後で時間ができたらやろう」とマニュアルづくりは後回しにされます。もちろん、実際に「後でやる」ことはありません。

　そうならないためには、マニュアルは、わざわざ時間を確保してつくるのではなく、実際の業務をしながらつくってしまうのがお勧めです。「作業メモ」を取りながら仕事を進め、そのメモをそのままマニュアルにしてしまうのです。このやり方なら、忙しさに関係なくマニュアルが蓄積されていきます。

　これは後任者のためだけでなく、自分のためにもなります。メモという形で自分の業務を整理することで、新しい気づきが得られるかもしれません。

マニュアルの経年劣化にどう対応するか

　どんな情報も、時の経過に伴って古くなっていきます。それはマニュアルも例外ではありません。業務内容は時々刻々と変化していきますから、マニュアルの情報が古くなって使えなくなる日は必ずやってきます。このような“マニュアルの経年劣化“には、どう対応するのがよいのでしょうか。

　一番よいのは業務内容が変わるたびにマニュアルを最新のものにアップデートすることですが、現実には時間が取れずに古いまま放置されることも多いものです。そこで最低限、マニュアルの情報が古くなった部分には「この情報は古い情報です」と注記だけはするようにします。とりあえず「古い」ことさえ分かれば、古い情報をそのまま使ってしまうという事故を防げるからです。

　なお、マニュアルに限ったことではありませんが、チーム内の共有ドキュメントは、放っておくと乱雑になっていく傾向があります。定期的に要らないものを削除するなどして整理するとよいでしょう。古い情報を延々と残しておくのは事故の元なので、おすすめできません。

読まれないマニュアルに価値はない

　マニュアルをつくる際に忘れてはならない視点があります。「読んでもらえるように書く」ということです。

　当たり前ですが、マニュアルには必ず「読者」がいます。自分の作業メモをそのままマニュアルにする場合でも、読者として“未来の自分”がいます。デザインや形式にこだわる必要はないものの、最低限読者に通じる書き方をする気持ちは持たなければなりません。

　また、チームのルールやコーディング規約などを「啓発」するためにドキュメントをつくる場合は、ただ書くだけでなく「読んでもらうための工夫」を入れると効果的です。例えば、僕が以前働いていたチームでは、コーディング規約が書かれたドキュメントに「くだらない冗談」が大量に含まれていました。これも、飽きずに最後まで読んでもらうための工夫の一つです。

　誰にも読まれないマニュアルを書くことは、完全に時間のムダです。あとで読む人がいるから、書く意味があるのです。そのことを忘れないようにしましょう。（日野 瑛太郎）