ダメなドキュメントを見抜く方法
IT関連の業務で作成されるドキュメントというのは、何故にこんなに質が低いのでしょうか。答えは簡単で、読む側が質を判断できないからです。好み、作成したときの苦労などの単なる思い入れでドキュメントの質を判断しています。あと最悪なのは、作るのが面倒くさいから既存のものを「基準」にしてしまうことです。理由もなく似せることが正解になって、何度も同じ失敗を繰り返すことになります。
まず、ドキュメントの質を判断する基準がありません。仕事でドキュメントを書いていると、要件ばかり積み重なって不可能案件になりやすいです。基本的に一つのドキュメントに対して要件は一つです。「初心者が読んでも分かる」とか「専門用語を省く」ということを要件として挙げる人がいますが、これらは要件ではなく方向性です。本当の要件は「○○について記載する」です。この要件に対してどれだけ応えられているかがドキュメントの質です。
ダメなドキュメントほど複数の要件が詰め込まれていて見た目が豪華です。基本的に「力作ほどクソ」です。これはドキュメントに限らずですが、スキルが低い人ほど技巧に凝っていろいろな要素を詰め込みたがります。スキルが低いままで頑張ると、この傾向が加速します。つまり、普段からスキルを伸ばす努力をしない人が成果を求めると、必然的に「力作ほどクソ」になります。どんなに頑張っても出てくるものが「クソ」なので、苦労が報われることはありません。
質の悪いドキュメントを見抜くには、ドキュメントに書かれている内容を別の紙に書き出してみましょう。多くの情報を詰め込むと不整合や抜け漏れが必ず発生します。要素をバラバラに分解して整理することで、その不整合や抜け漏れを確認することができます。慣れてくると、ドキュメントを見て三分でどのような情報が書けているか見当がつくようになります。情報がどうカテゴライズされているかというところに注意して要素を分解して書き出すことがポイントです。
最初はなかなか上手く書き出せませんが、訓練だと思って何度もやってみてください。そのうち、劇的に読解力が伸びます。この方法は一般の書籍にも使える方法です。技術書を読むときにこの方法を活用すると、技術書の特徴やコンセプトをつかむのに役立ちます。何となく雰囲気で善し悪しを判断するのではなく、何が書いてあるのかコンセプトを理解することが大事です。いろいろなことに応用ができるので、ぜひ「書かれている内容を別の紙に書き出す」はやってみることをお勧めします。