ドキュメント作成のコツ。「伝えた」と「伝わった」の壁をこえる。
こんにちは、プロダクトマネージャー のたけまさです。
職業柄、毎日たくさんのドキュメントを読みます。そして書きます。
今回はドキュメント作成で内容をわかりやすく伝えるコツを紹介します。
事業会社内で日常的に作成するドキュメントをターゲットとしています。
前提
ドキュメントは職種を越えて、受け渡しされる
仕事におけるドキュメントは、自分と同業種だけではない相手に向けて作成する機会も多くなります。例えばPMのわたしの場合はこのようになります。
インプット：営業、マーケ、サポートなどの方がまとめてくれた情報など
アウトプット：一緒に開発を行うエンジニアに向けたPRDや情報共有など
業務に関する情報の受け渡しを図にするとこうなります。
自分の作成したアウトプットは、他者へのインプットになります。
「伝えた」と「伝わった」はイコールではない
前述の通り、企業内の情報交換は業種を超えて行われます。各職種がパフォーマンスを発揮するために必要な情報も異なります。
ドキュメントを通じたコミュニケーションの成立には「自分が伝えたい情報」と「相手が必要とする情報」の一致が必要です。
一方的な「伝えた」だけでは、コミュニケーションとして成立せず、相手の理解や協力を得ることは難しい状態が起こります。
「伝えた」と「伝わった」はイコールではないことを意識しましょう。
自分が情報を受け取る時は、自分の業務には何が必要なのか伝えること。
自分が情報を提供する時は、相手の業務に何か必要なのか聞くこと。
ドキュメントの作成を始める前に、ひとこと声を掛け合うだけで認識齟齬は緩和できます。
伝わるドキュメントのコツ
前段でコミュニケーションに対するスタンスの整理をしました。
ここからはドキュメント上の表現のコツを具体的に紹介します。
はじめに「概要」や「結論」を用意すること
ドキュメントは、何について書いたものなのか？主張は何か？
読み手の頭の中に「理解の手がかりとなる地図」を作成しましょう。
主語・目的語・述語を明確に書くこと
情報伝達の基本にして奥義。何を言ってるかわからない問題の原因。
BtoBのプロダクトではアプリ内で「管理者、 担当者、実行者」など複数のユーザーが存在するケースがあります。主語が抜けてしまうと「誰の何の課題を解決するのか」を他者に正確に伝えることができません。
# 悪い例
・XX画面で、並び順を変更したい
・XX画面で、承認フローを追加したい
# 良い例
・担当者は、XX画面で、YY項目の並び順を変更したい
・管理者は、XX画面で、YY項目の承認フローを追加したい
質問にはストレートに回答すること
質問に対する答えと関係ない情報は、大胆に削りましょう。
論点のズレた情報が増えるほど、読み手の理解は難しくなります。
注意点：これは仕事以外ではほどほどに…
# 悪い例
・Q：今日のカレーの肉は何？
・A：今日スーパーの特売チラシが入っててちょうどジムに行く予定があったからついでに寄って、豚と鶏肉がすごく安くなっててすごく迷ったけどたんぱく質とりたいから鶏肉にした！
# 良い例
・Q：今日のカレーの肉は何？
・A：鶏肉。
長文は分割すること
長文は１文に複数の論点が混ざり、読み手が内容を理解する負荷が高い。
長文は目を動かす往復作業が多くつらい。
箇条書きを活用し、論点を切り分けて、短文で書きましょう。
# 悪い例
今日スーパーの特売チラシが入っててちょうどジムに行く予定があったからついでに寄って、豚と鶏肉がすごく安くなっててすごく迷ったけどたんぱく質とりたいから鶏肉にした！
# 良い例
・今日はスーパーの特売チラシが入っていた
・ジムに行く予定のついでにスーパーに寄った
・特売で豚と鶏肉がすごく安くなっていた
・たんぱく質を多く摂取するために鶏肉にした
「られる」表現の使用を控えること
「られる」表現は、「する」表現に比べて、読み手の理解の負荷が高い。
文章の構造がシンプルになる主体を選びましょう。
# 悪い例
・リンゴが青虫に食べられている
・バスに乗せられた少年が揺られている
# 良い例
・青虫がリンゴを食べる
・バスに乗車した少年が揺れている
影響は数字で語ること
量、頻度、割合、効果などは数字で表現できると説得力があります。
# 悪い例
・たくさんZZ機能に追加要望がきている
・ほとんどのユーザーに影響がある
・たまに話にきく
# 良い例
・合計700件のZZ機能の追加要望がきている
・95%のユーザーに影響がある
・月に1回程度は話にきく
まとめ
日常的な業務ドキュメントは、読み手に理解の負荷なく、重要な情報が頭に入ることが求められます。「伝える」と「伝わった」の両方に意識を向けながら、表現を考えていきましょう！
議事録の書き方についての記事はこちら
おすすめの書籍
普段の文章表現や、仕事で使うフォーマットで参考になる本です。
この記事が気に入ったらサポートをしてみませんか？