Skip to content

필사 모드: ドキュメントでコミュニケーションする方法 — 何度も読み返される文章を書く

日本語
0%
정확도 0%
💡 왼쪽 원문을 읽으면서 오른쪽에 따라 써보세요. Tab 키로 힌트를 받을 수 있습니다.
원문 렌더가 준비되기 전까지 텍스트 가이드로 표시합니다.

はじめに: 話は一度、ドキュメントは百度読まれる

LINEで働いていた頃、ある同僚が退職時に残したウィキのドキュメント一つが、ずっと記憶に残っています。彼が去った後もそのドキュメントは生き残り、新しい入社者が来るたびに読み返されました。一年でそのドキュメントを読んだ人は数十人でした。彼はそのドキュメントをたった一度書いたのに、その文章は数十回働きました。

反対の経験もあります。ある機能を誰が、なぜ、どう作ったのか何の記録もなく、コードだけを見て長いこと追跡しなければならなかったことがあります。そのコードを書いた人はすでに去り、彼が頭の中に持っていた文脈は一緒に消えました。そのとき痛感しました。ドキュメントに残さなかった知識は、それを知る人が去った瞬間に一緒に死ぬのだと。

話は揮発します。会議でどれほど明快に説明しても、その場にいなかった人には届かず、その場にいた人も一週間後には半分を忘れます。ドキュメントは違います。ドキュメントは眠らず、時差を越え、人が去った後も残ります。

この文章は華やかな文章術についてではありません。「読み返される文章」、つまり時間が経っても、作成者がそばにいなくても役割を果たす実用的なドキュメントを書く方法についてです。

核心の洞察: ドキュメントは協業と引き継ぎの中心である

ソフトウェアを作る仕事は本質的に協業です。そして協業の半分以上は「知識の移動」です。自分の頭の中にあるものを他人の頭の中へ移すこと。この移動の媒介がまさにドキュメントです。

ドキュメントが重要な理由は三つの非対称性にあります。

第一に、時間の非対称性です。文章は一度書きますが、何度も、複数の時点で読まれます。私が書くのに30分余分にかけて、読む人50人の時間をそれぞれ5分ずつ節約できるなら、それは圧倒的に得な投資です。

第二に、空間の非対称性です。分散したチーム、異なるタイムゾーン、異なるオフィス。全員を一つの会議室に集めることはできません。ドキュメントは全員が同じ情報にアクセスできるようにする、唯一スケール可能な手段です。

第三に、人員の非対称性です。人は去ります。転職し、部署を移り、休暇に出ます。人にだけ保存された知識はその人と一緒に消えます。ドキュメントは去った人の知識を組織に残します。

> コードは「どう(how)」を語る。ドキュメントは「なぜ(why)」を語る。そして六か月後のあなたを最も悩ませる問いは、いつも「なぜ」だ。

だから良いドキュメントは親切な引き継ぎです。未来の同僚へ、そしてすべてを忘れた六か月後の自分自身へ送る手紙です。

絶えず読み返されるからこそ丁寧に

ここで重要な視点の転換が必要です。ドキュメントは「書くもの」ではなく「読まれるもの」です。文章の価値は書く瞬間ではなく、読まれる瞬間に発生します。

この視点で見ると、ドキュメント作成のコスト構造が逆転します。私が文章を書くのにかかる時間は一回限りです。しかし人々がその文章を読むのにかかる時間は、読む回数だけ掛け合わされます。100人が読むドキュメントなら、私が文を1分磨いてそれぞれの理解時間を10秒ずつ減らすだけでも、全体としては莫大な時間が節約されます。

だからよく読まれるドキュメントほど丁寧に書くべきです。一度読んで捨てるメモと、数十人が長く参照するオンボーディングガイドは、かけるべき手間が違います。

作成者と読者の間には決定的な情報の非対称性があります。作成者はすべての文脈を頭の中に持っていますが、読者は白紙から出発します。作成者には当たり前すぎて省略したその一行が、読者には文章全体を理解できなくする決定的な穴になります。これが認知心理学で言う「知識の呪い(curse of knowledge)」です。自分が知っていることを他人も知っていると無意識に仮定する罠です。

丁寧なドキュメントはこの呪いを意識的に破ります。「この文章を初めて見る人がこれを理解できるか」を絶えず自問します。それが読み返される文章の出発点です。

良いドキュメントの構成: 目的・文脈・結論を先に

最もよくある致命的な間違いは「時間順に」書くことです。自分が知っていった順、つまり背景から始めて過程を経て結論へ行くやり方です。これは作成者には自然ですが読者には拷問です。読者は結論を早く知りたいのに、最後まで読まなければ結論が出ないからです。

良いドキュメントは結論を先に置きます。新聞記事が核心を第一段落に置く「逆ピラミッド(inverted pyramid)」構造と同じです。アマゾンが社内で使う6ページのドキュメント文化や、「BLUF(Bottom Line Up Front、結論から)」という軍隊式の原則も同じ哲学です。

推奨するドキュメントの骨格はこうです。

[タイトル] — 何についてのドキュメントか一目で

1. 一行要約 (TL;DR)

- このドキュメントから知るべきただ一つ

2. 目的 / 背景

- なぜこのドキュメントが存在するのか

- 誰が読むべきか

3. 結論 / 核心の主張

- 何をすべきか、何が決まったか

4. 根拠 / 詳細説明

- なぜその結論に至ったか

- 検討した代替案とトレードオフ

5. 実行 / 次のステップ

- 具体的に誰が何をいつ

6. 参考 / 付録

- 関連リンク、用語、追加資料

この構成の核心は「逆ピラミッド」です。最も重要な情報が上にあり、下へ行くほど詳細になります。だから忙しい読者は上の三項目だけ読んで去ることができ、深く知るべき読者は最後まで読めます。同じドキュメントが異なる深さの読者をすべて満足させるのです。

もう一つの原則: 「なぜ」を必ず残してください。「何をしたか」はコードと成果物に残りますが、「なぜそうしたか」は作成者の頭の中にだけあります。六か月後に誰かが「これはなぜこうしたのか」と問うとき、その答えがドキュメントにあれば、そのドキュメントは黄金です。特に検討したが採用しなかった代替案とその理由を書いておけば、未来の誰かが同じ悩みを繰り返すのを防げます。

読者への配慮: 誰のために書くのか

良いドキュメントは読者を頭に描きながら書きます。「この文章の最初の読者は誰か」をまず決めなければなりません。

読者によって同じ内容も違うように書くべきです。

| 読者タイプ | 彼らが求めるもの | ドキュメントが強調すべきこと |

| --- | --- | --- |

| 意思決定者 | 結論と影響 | 要約、コスト、リスク、推奨案 |

| 同僚の開発者 | 実装方法と理由 | 設計根拠、トレードオフ、例コード |

| 新入社員 | 全体の文脈 | 背景、用語定義、段階的な案内 |

| 未来の自分 | 当時の判断根拠 | なぜこう決めたか、代替案の記録 |

読者への配慮の具体的な実践はこうです。

第一に、専門用語を初めて使うとき解説します。略語は最初の一度だけ展開し、括弧で略語を併記します。作成者に馴染んだ社内用語が、読者には宇宙語かもしれません。

第二に、スキャンできるようにします。人はドキュメントを精読せず流し読みします。見出し、太字、箇条書き、表を活用して、流し読みだけでも構造が見えるようにします。一段落が五行を超えたら分割を検討してください。

第三に、例を与えます。抽象的な説明十行より具体的な例一つのほうが優れています。特に「こうしてください」と「こうしないでください」を並べて見せると、理解が劇的に速くなります。

第四に、読者の次の行動を明確にします。ドキュメントを読み終えた読者が「で、私は何をすればいいのか」と問わないよう、次のステップをはっきり書きます。

非同期コミュニケーション: ドキュメントが会議を代替するとき

ドキュメントは非同期コミュニケーション(asynchronous communication)の核心的な道具です。非同期コミュニケーションとは、全員が同時に同じ場にいなくてもよいコミュニケーションです。

会議(同期コミュニケーション)は強力ですが高くつきます。参加者全員の時間を同じ時刻に縛らねばならず、一度過ぎれば揮発し、発言権は声の大きい人に偏りがちです。一方、よく書かれたドキュメントは各自が都合のよい時間に読み、永久に残り、文字で書けばすべての人の意見が等しく記録されます。

GitLabのような完全リモートの会社は「ドキュメント優先(documentation first)」の文化を明示的に採用しています。核心となる原則は「会議を開く前にまずドキュメントを書け」です。会議で初めて問題を説明するのではなく、あらかじめドキュメントで共有した後、そのドキュメントにコメントで非同期の議論を進めます。会議は本当にリアルタイムの対話が必要なとき、つまりドキュメントでは解けない意見の衝突があるときだけ開きます。

非同期コミュニケーションの利点は明確です。

- 深く考える時間が生まれます。文字で答えるには即興の反応ではなく整理された考えが出ます。

- 時差と日程に自由です。分散したチームに必須です。

- 自動的に記録が残ります。議論そのものがすぐドキュメントになります。

- 内向的な人も等しく参加します。会議で話す隙をつかめない人も、文字では十分に貢献します。

ただし非同期にも限界があります。感情が絡む繊細な対話、速いブレインストーミング、複雑なリアルタイムの協議は、依然として同期のほうが優れています。核心はどちらか一方ではなく適切な分配です。情報の伝達と意思決定の記録はドキュメントで、リアルタイムの合意と関係構築は対話で。

ドキュメントテンプレート: すぐ使える骨格

毎回白紙から始めるとドキュメント書きが負担になります。よく書くドキュメントはテンプレートを作っておくと敷居が低くなり、一貫性が生まれます。

設計ドキュメント (Design Doc)

[タイトル] 設計ドキュメント

TL;DR

- 一行要約

背景 / 問題

- 何を解決しようとするのか

目標 / 非目標

- この作業が達成すること / あえてしないこと

提案する方針

- 核心の設計

検討した代替案

- 代替案A、Bと採用しなかった理由

リスク / 影響範囲

- 予想される危険と緩和策

日程 / 次のステップ

- 誰が、何を、いつ

決定記録 (ADR, Architecture Decision Record)

[番号]. [決定タイトル]

ステータス

- 提案中 / 採用 / 廃止

文脈

- どんな状況でこの決定が必要だったか

決定

- 我々が決めたこと

結果

- この決定で生じる肯定的・否定的な影響

議事録 / 非同期決定

[日付] [テーマ]

結論 (先に)

- 決まったこと一目で

アクションアイテム

- [ ] 担当者 — やること — 期限

議論内容

- 核心の論点まとめ

テンプレートの目的は形式を強制することではなく、「何を漏らしてはいけないか」を思い出させることです。特に「検討した代替案」と「決定の理由」は、人々が最もよく漏らしますが最も価値のある項目です。

事例: 同じ情報、異なるドキュメント

抽象的な原則を具体化してみましょう。新しいデプロイ手順を共有するドキュメントを二通りで比べます。

方式A — 作成者中心

「先週デプロイ関連でちょっと問題があって、それでいくつかの方案を検討したんですが、最初はAを考えてBも見て、結局議論の末に新しい手順を導入することにしました。詳しくは下に...」

方式B — 読者中心

「要約: 本日からデプロイは必ずステージングを経ます。従来の方式と違う点はただ一つ、『ステージング承認』の段階が追加されたことです。

対象: デプロイ権限のあるすべての開発者

施行: 2026年6月19日から

理由: 先週の直接デプロイによる障害の再発防止

新手順 (3段階):

1. PRマージ

2. ステージング自動デプロイ後に確認

3. 承認ボタンをクリック → 本番デプロイ

従来と変わった点だけ見るなら: 3番の承認段階が新しくできました。」

方式Bが優れている理由は、読者が知るべきことを読者の順序で配置したからです。結論を先に、対象と時点を明確に、変更点だけをはっきりと。読者は自分に必要な部分だけ素早く見つけて去れます。

落とし穴: 過剰なドキュメント化を戒めよ

ここまでドキュメントの価値を強調してきましたが、バランスが必要です。ドキュメント化は道具であって目的ではありません。過剰なドキュメント化は不足したドキュメント化と同じくらい有害です。

落とし穴1: 誰も読まないドキュメント

作るために作ったドキュメント、形式を埋めるためのドキュメントはコストだけを発生させます。すべてをドキュメント化しようとすると、肝心の重要なドキュメントがノイズに埋もれます。ドキュメントを書く前に問うてください。「これを誰が、いつ、なぜ読み返すのか。」答えがなければ書かないでください。

落とし穴2: 古びたドキュメント (Documentation Rot)

最も危険なドキュメントは無いドキュメントではなく間違ったドキュメントです。コードは変わったのにドキュメントは昔のままなら、そのドキュメントは読者を積極的に誤導します。保守できないドキュメントはいっそ書かないほうがましです。だから「どこに何があるか」を指す軽いインデックスドキュメントが、すべての詳細を盛り込んだ重いドキュメントより長く生き残ることがよくあります。

落とし穴3: ドキュメントがコードを重複

コードをそのまま日本語に移したコメントやドキュメントには価値がありません。コードが「どう」をすでに語っているなら、ドキュメントは「なぜ」に集中すべきです。

落とし穴4: 完璧主義による麻痺

完璧なドキュメントを書こうとして何も書かないより、70%のドキュメントでもあるほうがましです。ドキュメントは生きているもので、後で直せます。「草案ですが共有します」が「完璧になるまで非公開」よりほぼ常に優れています。

バランス点はこうです。よく読まれ、長く使われ、人が去ると消える知識 — こういうものをドキュメントに残してください。一度書いて終わるもの、コードにすでに明白なもの、すぐ変わるものはドキュメント化しないでください。

書く過程: 草稿と推敲は別の仕事だ

良いドキュメントは一度では出てきません。文章を書くのが苦手な人によくある勘違いは、頭の中で完璧な文を作って一度に書き下ろそうとすることです。すると最初の一文から詰まります。文章を書くことは二つの別々の作業です。第一は考えを吐き出す仕事(草稿)、第二はそれを整える仕事(推敲)です。この二つを同時にやろうとすることが、文章を書くのを苦しくする主犯です。

作家がよく引用する原則があります。「草稿はひどくてよい(write drunk, edit sober)」の精神、つまり草稿は速く荒く、推敲は冷たく冷静に。草稿の段階では綴りも文の磨きも忘れて、ただ頭の中のものをすべて出します。構造がめちゃくちゃでも構いません。まず材料があってこそ整えられます。

推敲の段階がドキュメントの質を決めます。推敲するときは作成者ではなく読者の目で読みます。特に次を点検します。

- 結論が上にあるか、それとも最後まで読まないと出ないか

- 一つの文に複数の考えが絡まっていないか(一文一思考)

- 初めて見る人が詰まる地点はどこか

- 抜いても意味が通る贅肉は何か

特に最後、「抜いてよいものを抜くこと」が推敲の核心です。フランスの作家サン=テグジュペリは「完璧とは、付け加えるものがなくなったときではなく、取り去るものがなくなったときに達成される」と言いました。良いドキュメントは長いからではなく短いから良いのです。読者の時間は高く、贅肉はその時間を盗みます。

一つ実用的なコツ: 発行前に声に出して読むか、一日寝かせてから見直してください。書くときには見えなかったぎこちなさや穴が、時間を置くと見えます。そしてできれば同僚に「初めて見て、理解できる?」と聞いてください。知識の呪いを破る最も確実な方法は、実際の読者の目です。

ドキュメントが住む場所: 発見可能性の問題

どれほどよく書いたドキュメントも、誰も見つけられなければ無いのと同じです。ドキュメント化の隠れた半分は「発見可能性(discoverability)」です。ドキュメントがどこにあるか、どう検索されるかが、内容と同じくらい重要です。

よくある失敗はドキュメントがあちこちに散らばることです。ある人はウィキに、ある人はスラックのメッセージに、ある人は個人メモに書きます。その結果、同じ質問が繰り返され、すでにある答えを見つけられず作り直します。情報の重複と矛盾が積み重なります。

発見可能性を高める実践はこうです。

- 単一の信頼できる情報源(single source of truth)を決める。「このテーマはここにある」という合意された場所。

- 検索される題を書く。人々が実際に検索する単語を題に入れる。

- インデックスドキュメントを置く。「何がどこにあるか」を指す軽いハブドキュメント。

- 関連ドキュメント同士をリンクでつなぐ。一つを見つければ隣接するものへ続くように。

ここで先に述べた「古いドキュメント」の問題が再び登場します。検索はよくできるのに内容が間違ったドキュメントが最も危険です。だから発見可能性と最新性は一緒に行かねばなりません。古いドキュメントには「最終更新: 日付」を明示するか、もはや有効でなければ明示的に「保管済み(archived)」と表示するのがよいです。

隠れた効用: 書きながら考えが整理される

ドキュメントの価値を「他人に伝えること」だけで見ると、半分を見落とします。ドキュメントを書く行為そのものが、考えを整理する強力な道具です。つまり、ドキュメントは読者だけでなく作成者にも利益です。

頭の中で分かっていると感じていたものを、いざ文章に書こうとすると、あちこちで詰まります。「あ、この部分は実は自分が明確に分かっていなかったんだ」「この二つの段階の間に論理の飛躍があるな」。文章を書くことは考えの穴を容赦なく暴きます。話ではごまかせますが、文章はごまかしを許しません。

これを「文章を書くことは考えのデバッグ」と呼べます。曖昧な考えは曖昧な文章になります。文章が明瞭にならないなら、それはたいてい文章力の問題ではなく、考えがまだ明瞭でないというシグナルです。だから設計をコードに移す前に設計ドキュメントを先に書けば、実装段階で出会う問題のかなりを前もって発見します。

アマゾンが会議でスライドの代わりに6ページの叙述型メモを書かせる理由がここにあります。ジェフ・ベゾスは文章による叙述が「より明確に考えることを強制する」と言いました。箇条書きは論理の隙間を隠せますが、完全な文による叙述はその隙間を暴きます。

だからドキュメントを「仕方なくやる付随作業」とみなさないでください。重要なことを始める前に一ページでも書いてみることは、他人のためである前に、自分の考えを明瞭にすることです。しばしばその過程で、書く前には見えなかったより良い方向が思い浮かびます。

よくある質問 (FAQ)

たいてい草稿と推敲を同時にやろうとするからです。一文を完璧に整えながら次へ進めないのです。まず荒く全部吐き出してから整えてください。もう一つ、毎回白紙から始めずテンプレートを使ってください。そしてすべてのドキュメントに同じ手間をかける必要はありません。よく読まれるドキュメントにだけ深く投資し、一回限りのメモは軽く書く分別が時間を節約します。

会議はその瞬間は速いです。しかし揮発します。その場にいなかった人、一週間後に忘れた人、六か月後に入った人には届きません。会議が速いのは「今その場にいる人たち」にだけです。決定と情報の伝達はドキュメントが、リアルタイムの合意と議論は会議が優れています。最良の組み合わせは「会議前にドキュメントで文脈を共有、会議では決定、会議後にドキュメントで決定を記録」です。

三つを点検してください。第一に、結論が上にありますか。最後まで読まないと核心が出ないなら、人々は途中で去ります。第二に、見つけられますか。発見可能性の問題かもしれません。第三に、本当に必要なドキュメントですか。誰も読まないなら、そもそも書く必要がなかったのかもしれません。読まれないドキュメントは、しばしば内容ではなく構造や位置の問題です。

コメントとドキュメントは役割が違います。コメントは「このコードが何をするか」の近い文脈に良いですが、「なぜこのシステムをこう設計したか」「どんな代替案を検討したか」のような大きな絵は捉えにくいです。またコメントはコードを読む人にだけ届きます。意思決定者や新入社員はコードを読みません。コードコメントは「どう」の近い文脈、ドキュメントは「なぜ」の大きな文脈 — 両方が必要です。

ドキュメント作成チェックリスト

ドキュメントを発行する前、次を点検してください。

- 最初の一行を読んで「何についてのドキュメント」か分かるか

- TL;DRまたは結論が一番上にあるか

- 「なぜ」が書かれているか(何だけでなく)

- 初めて見る読者が理解できるか(知識の呪いの点検)

- 略語と専門用語を解説したか

- 流し読みするだけで構造が見えるか(見出し、リスト、表)

- 読者の次の行動が明確か

- 検討したが採用しなかった代替案を書いたか

- 六か月後にも誰かが保守できるか

- このドキュメントを本当に誰かが読み返すか(それとも会議のほうがよかったか)

もう一つ: 図と表の力

長い文章が常に最善とは限りません。ある情報は文章より図や表で伝えるほうがはるかに速く理解されます。「百聞は一見に如かず」はドキュメントにも当てはまります。

特に次の情報は視覚化が強力です。

- 構造と関係: システムアーキテクチャ、データフロー、コンポーネント間の依存 — 図一つが三段落を代替します。

- 比較: 複数の選択肢の長所短所は、表で並べると一目で入ってきます。

- 順序と段階: プロセスや手順は、番号リストやフローチャートが地の文より明確です。

- 時間の流れ: 日程や変化はタイムラインで。

ただし視覚化にも落とし穴があります。第一に、保守コストです。図は文章より直すのが面倒なので、内容が変わっても放置されやすいです。だから頻繁に変わる内容は、いっそ文章で残すほうがよいときがあります。第二に、華やかさの落とし穴です。きれいな図を作るのに、肝心の内容に使うべき時間を奪われないでください。粗い手描きでも核心を伝えれば十分です。

核心の原則は「各情報に合う形式を選ぶこと」です。すべてを地の文で書きも、すべてを図で描きもしないでください。構造は図で、比較は表で、文脈と理由は文章で — 情報の性格に合う器を選ぶことが、読者を配慮するもう一つの方法です。

おわりに: 未来へ送る手紙

もう一度、LINEでのあのウィキドキュメントに戻ります。去った同僚のそのドキュメントが長く記憶に残った理由は、単に上手に書かれた文章だったからではありません。彼が自分の去った後を考え、会ったことのない未来の同僚を配慮して書いたのが伝わったからです。

ドキュメントを書くということは、時間をさかのぼって人を助けることです。今30分をかけて、六か月後の誰かがさまよう半日を節約してあげます。作成者が去った場所でも、その文章は働き続けます。

良いドキュメントは華やかである必要はありません。ただ読み返される必要があります。結論を先に置き、なぜを残し、初めて見る人を配慮し、本当に必要なものだけ書くこと — それが読み返される文章のすべてです。

そして覚えておいてください。完璧なドキュメントを待って何も残さないより、70%でも今残すほうがほぼ常に優れています。ドキュメントは生きているもので、次の人が直し、足せます。最初の一文を書くのが最も難しいです。いったん始めれば、考えは文章を追って整理されます。

あなたが今日書くドキュメントは、あなたが忘れた後もあなたに代わって語ります。だから未来の読者へ親切な手紙を書いてください。その読者には六か月後のあなた自身も含まれます。

参考資料

- Larson, W. _An Elegant Puzzle: Systems of Engineering Management_ (2019) および lethain.com (https://lethain.com).

- GitLab Handbook, "Documentation" and "All Remote" (https://handbook.gitlab.com).

- Heath, C. and Heath, D. (2007). _Made to Stick_. Random House. (知識の呪いの概念)

- Amazon の "6-page narrative memo" 文化 — Harvard Business Review (https://hbr.org).

- Nielsen Norman Group, "How Users Read on the Web" (https://www.nngroup.com).

- Architecture Decision Records (ADR), Michael Nygard (https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions).

현재 단락 (1/149)

LINEで働いていた頃、ある同僚が退職時に残したウィキのドキュメント一つが、ずっと記憶に残っています。彼が去った後もそのドキュメントは生き残り、新しい入社者が来るたびに読み返されました。一年でそのドキ...

작성 글자: 0원문 글자: 10,344작성 단락: 0/149