意思決定をサポートするドキュメンテーション

#Engineering#Documentation

ドキュメントって書くのって非常に難しいですよね。いや、書くのは簡単ですが相手に伝わるドキュメントを書くのが非常に難しいですよね。

ドキュメンテーションはスキルの一つ

同じ領域で仕事をしている人へのドキュメントは文脈を読んでくれるので大体は伝わります。しかし、領域外の人はそもそもの文脈を理解していないので、客観的に書かれていない文章を理解するのに頭を意外と使います。

日本人は小学生や中学生の頃から国語の授業で『この一文のときの主人公の気持ちを20文字で記載しなさい。』といった問題で訓練されているので、文脈を汲み取ろうとする文化があります。

しかし、一般的に用いられない自分の領域内の用語や単語を使っていたりすると、ドキュメントを読むのに時間が掛かってしまうこと繋がります。難しい用語や単語を一般的な用語や単語に置き換えることや、論理展開を相手の思考回路に合わせて記述していくことによってドキュメントの理解度の向上につながります。

どれだけ客観的に物事を記載していくかで相手の理解度が変わっていきます。さて、今回は『意思決定』を主軸をおいたドキュメントの書き方を紹介します。

ドキュメンテーションの答えはひとつじゃない

下記は僕が別のドキュメントに記載していたことを転載しています。

これは正解ではなくあくまで一例なので、自分自身で客観的で伝えやすいドキュメントの構造を学んでいってください。

Prerequisite: 背景となる前提

なぜ、このドキュメントが存在するのかを背景を踏まえて明記する

  • このドキュメントが生まれた背景となる課題感
  • このドキュメントを通して何を成し遂げたいのか記載する

    • 何をしないのかも記載すると絞りやすくなる
    • お互いの共通認識をもつ

AsIs/ToBe: 現実と理想からのギャップ

理想形を作って、現実に落とし込む

  • 理想形をつくるためにリソース(人、物、金)について言及しないで考える
  • 理想の形から現実に落とし込むときにリソースについて言及する

    • 理想と現実のギャップから課題が発見されるため、それを解決するために必要な要素を洗い出す
  • 現実に落とし込むときは一つだけに固執せず、複数パターンを列挙して現実でのやり方を落とし込む

Pros / Cons: 長所と短所を理想と現実のパターンから洗い出す

パターンから長所と短所の洗い出しをする

  • AsIs / ToBeから洗い出された複数パターンについてPros/Consを洗い出す
  • 人、チーム内、チーム外、プロジェクト、組織、経営の各目線を変えて長所と短所を見出す
  • テクニックとして、マトリクスで表記するのが見やすい

ToDo: ネクストアクションを決める

パターン決定ないしはパターンをいくつか絞ったことに対するTODOをまとめる

  • ToDoについてはコントローラブルとアンコントローラブルについて切り分けておく
  • 時間差となるタイムラインを踏まえて重要性と緊急性を考えておく

気をつけること

  • 最初から論理思考フレームワーク(MECEなど)を使うことはやめる

    • フレームワークを使うと「っぽく」はなる。なるけどゴールが噛み合わなくなるので議論が収束しにくいのと納得感も生まれにくい
    • なぜならば、『それはあなたの世界における思考であって、世界がわからなければそのMECEが正しいかもわからない』状態になってしまう
    • つまり、世界を理解するためのドキュメントの前提となる Prerequisite が重要

おわりに

今回は要点だけ書いたので実際の書き方はピンと来ないかもしれないですが、機会があればそれも書こうかなと思います。

ちなみに、この文章も読みにくい人は一定数いると思っていますが、ためらうよりはたくさん書いた方が特訓になると割り切っているので、悩んでしまうならまずは手を動かしましょう!

Let's document all of your stuff to be easy to understand them for all employees. 📝

おすすめ

B!

Shintaro Kaneko

September 23, 2020