ドキュメンテーションって自然には向上しにくいんです。
なぜかというと、今一つピンとこないから。
何をしたらどう向上するのかが曖昧で、ついつい後回しにしがち。
そして意識的に高めようと思わないと中々向上していかないもの。
これを見ている方は、少なからずドキュメンテーション能力を向上させたいと思っている人だと思います。
「色々気を付けているけど、今一つドキュメンテーション能力が向上しない」
「何が悪いのかわからない」
そんな人に向けた、ドキュメンテーション能力を向上させる技をご紹介します！
少し気を使うだけで、一気にドキュメンテーション能力が向上します！
今までの殻を破り、周りの人を驚かせ、大きな信頼を得ましょう！
ドキュメンテーション能力の定義
ドキュメンテーション能力とは、自分の考えを資料化し、その資料を見た他人が自分と同じ考えになるように資料を作成することです。
つまり、目的は「相手に伝わること」です。
なので相手に伝わらない資料は、資料の価値がありません。
「これってどういう意味？」
「これはこのことを指している？」
このような質問が挙がってくる資料は、成果物としてアウトです。
なので作成するときに一番重要になるのは
「読む相手を意識する」こと。
読む相手を意識し、読みやすく、内容を理解出来る資料を作成する能力を、ドキュメンテーション能力と定義しています。
コツ１ 最低限のルールの統一
最低限のルールは徹底しましょう。
・ですます調を合わせる
・てにおはを合わせる
・大項目から小項目へ
・他の資料と記載振りを合わせる
それぞれ見ていきましょう。
ですます調を合わせる
これがバラバラの資料は、論外です。
レビューするに値しません。
気を付ければ誰でも統一させることが可能です。
必ず、統一しましょう。
てにおはを合わせる
読みやすくするための技です。
これを意識するだけで、大きな飛躍に繋がります。
例：
(主語)は、(述語)です。
夏は、暑い
プールは、混んでいる
このように、一つの資料の中で主語・述語の順番が統一されるだけで、一気に読みやすくなります。
日本語は順番がバラバラでも意味が通じる便利な言葉ですが、それゆえ統一感がないことが多く見受けられます。
主語・述語の順番を意識すると、てにおはも自然に統一されていきます。
大項目から小項目へ
話すときにもそうですが、資料を作成するときも同様に、大項目から小項目へ記載するようにしましょう。
例：
「夏のアイスの売れ行きについて」
季節別
└春
└夏
└秋
└冬
このように、始めに全体像を記載し、読み手の脳の領域を確保します。
どういうことかと言うと、他人の話を聞いていて「まだ話すのかよ」と感じたことはありませんか？
その原因は、始めに「これだけ話しますよ」と範囲を指定しないからです。
資料も同様に、序盤に範囲を指定することによって、読んでいる最中に「あと大体数ページだな」とわかり、読み手のモチベーションが維持出来ます。
他の資料と記載振りを合わせる
資料をゼロから作成することは稀です。
ベンチャー企業でない限り、必ず過去に作った似たような資料があります。
また、直接は関係がない資料でも、企業内部で統一フォーマットで作成していることが殆どです。
資料を作成するとき、他の資料を確認して、特徴を合わせるようにしましょう。
一つだけ毛色の違う資料を作成すると、その企業の一体感にも影響が出ます。
コツ２ 用途に適切に合わせる
作成しようとしている資料の使い道を理解し、使用しているイメージを沸かせてから資料作成に着手しましょう。
例：
「○○システムの監視マニュアルの作成」
監視する人は、マニュアルに沿って適切に作業することが求められます。
ですので、「空気を読んでくれ」のような記載の仕方はNGです。
１から１０まで明確に、丁寧に、誰が読んでも迷わない記載にしなければいけません。
「ユーザマニュアル」
ユーザは、システムの細かいロジックまではわかりません。
かつ知る必要のない人です。
なので、SQLなどの細かいロジックを書いても伝わりません。
マニュアルとしての存在意義はゼロです。
ユーザの作業に沿った項目を定義し、操作方法を具体的に書くことが求められます。
「システム設計書」
技術者は、逆にユーザ業務の細かい作業がわかりません。
かつ知る必要のない人です。
なので、業務項目に分けた資料は使い勝手が悪く、理解出来ないまたは理解に時間を要してしまうこともあります。
ソースレベルでフロー形式で記載し、関数マニュアルなどを用意すると良いでしょう。
上記のように、それぞれの用途に合わせ、また読む人の情報量にも合わせて記載することが、とても重要です。
まとめ
読み手を意識して、丁寧に資料を作成することによって、確実にドキュメンテーション能力は向上します。
少し面倒かもしれませんが、その面倒の先に、他者と差別化するくらいの能力が待っています。
ぜひ、実践してみてください。
