ドキュメントは、スタンドアロンであるべきだよなと最近よく思う。
MTGの場では伝わった気がしていたのに、あとから共有された人から全然違う解釈が返ってくる、みたいなことがある。そういうとき、たいてい悪いのはドキュメントの中身ではなくて、「自分が横にいて補足する」ことを暗黙の前提にして書いてしまっていたことなんだと思う(反省)
ドキュメントは、自分がいない場所で読まれる
そもそもドキュメントが読まれる場面はどんな場面か。ドキュメントではなくてもSlackメッセージだってそうだ。「MTGで画面共有をしながら」「コンテキストが十分に共有されている相手に渡す」などがぱっと思いつくし、書いてる時にはそこに重心を置いて、適宜省略したりしながら書いている。
が、本当にそうなのか。
確かにその場・その限りの相手の中で閉じたドキュメントも当然ある。が、意外と書いている自分がいない場面でもドキュメントは共有されることが普通に多い。ドキュメントは自分がいない場所でも読まれている。
- 口頭の説明を伴わない場面で参照される
- MTGの前に読まれるし、終わったあとに読み返される
- そのMTGに参加してなかった人にそのまま共有される
上記のような場面では、書いた人の補足なしで成立してもらわないと困る。後日聞かれても思い出すのも苦労する...
何を書いておくべきなのか
ストーリー・背景
なぜこの検討が始まったのか。何を解こうとしているのか。どんな文脈・前提があるのか。
ここがないと、本文が「誰かが決めた結論」しか見えない。読み手は賛成することも反対することもできない。行動しようにも、指針となる材料もない。判断材料がないので当然だと思う。
全体構成
このドキュメントに何が書いてあって、どこから読めばいいのか。
長いドキュメントほど、読み手は「自分が読むべき箇所」を選べないと、読むこと自体をやめてしまう。全部読んでもらえる前提で書いているのは、たぶん書き手の甘えだ。
生成AIが作成した「**」だらけの文章ベタ貼りなんて言語道断だ。
用語の説明
社内用語、プロジェクト固有の略語、同じ言葉を別の意味で使っている箇所。
ここが揃っていないと、読み手は議論の中身ではなく用語の解釈に時間を使うことになる。しかも本人はだいたい、解釈がズレていることに気づかない。
この3つを先にREADME的に整理しておけば、ドキュメントが単体で流通しても情報が正しく伝わって、読んだ人がすぐ動ける状態になる。
そもそも、読み手に何をしてほしいのか
ドキュメントの目的は、理解と納得をしてもらったうえで、何らかのアクションを取ってもらうことだと思っている。
だとすると、意識すべきは下記あたりだろう。
- 相手が理解するために必要な情報は何か
- 相手が納得できるストーリーになっているか
- 相手が読むべき箇所を選択できる構造になっているか
- 必要なアクションと期限は何か
「理解」と「納得」を分けているのは実は重要だ
何を言っているのか伝わらないと読まれることすらない。書いてある背景や変遷に「確かにそうだ」と納得をしてもらえないと、「必要なアクション」を促せない。
人と人のコミュニケーションだから
生成AI同士が代わりにやりとりしてくれる...時代ではまだなくて、人間がドキュメントを介して意思決定していくので、例え過程として生成AIでまとめるなりしようとも、人間に伝える時は相手に最大限配慮するというか、認知負荷とか、伝わりやすいのかとかを意識して用意してあげる方が良いのかなと思う。
「何が言いたいんだろう」とか「読みにくいなぁ」って人間もAIも思わないような整理整頓をしておくと、枝葉すぎる話とか、重要じゃないことに時間を使わくて良くなり、結果としてより良い時間の過ごし方が出来るのかなと思う(とは言えこれ毎回やるとコスト高すぎるけど)