ドキュメントが書けないとき|読み手を決めてから書く

ドキュメントが書けないと感じるとき、多くの場合は文章力ではなく、読み手と目的が決まっていないことが原因です。仕様書や設計メモを前に手が止まるのは、誰に向けて、何のために書くかが定まっていないためで、この2点を先に決めると、書く範囲が絞られて書き始めやすくなります。
書けないときにまず見直す軸は、読み手と目的を先に決めることです。誰が読み、何のために書くのかを言葉にしてから、書き始めると迷いが減ります。
Relasic(株式会社LASSIC運営)|リモートワーク対応の転職支援
この記事のポイント
- エンジニアの有効求人倍率は1.65倍で、全職業計の1.26倍を上回ります*1
- 書けない原因の多くは、文章力ではなく読み手と目的が決まっていないことです
- 読み手を1人に絞り、目的を1つに決めると、書く範囲が絞られます
1. ドキュメントが書けない原因を、書く前に見分けます
ドキュメントが書けない原因は、文章力ではなく、読み手と目的が決まっていないことです。情報処理・通信技術者の有効求人倍率は1.65倍、全職業計は1.26倍です*1。転職の機会が増えるいまも、書く力を求人票だけで示す場面は多くありません。読み手と目的を先に決めることが、書けないと感じる場面を減らします。
ドキュメントが書けないと感じる場面は、書き方や言い回しの問題として扱われがちです。実際には、その手前の段階でつまずいていることが少なくありません。
書く前の段階でつまずく場面の多くは、読み手が具体的に思い浮かんでいない、または目的が1つに定まっていない、のどちらかです。
文章の技術を磨く前に、この2点が決まっているかを確かめると、書けない原因がどこにあるかを切り分けやすくなります。
読み手と目的の両方が決まっている場合、書く内容は自然と絞られます。どちらか一方でも曖昧なままだと、何をどこまで書けばよいかの判断がつきにくくなります。
書けない原因を経験や知識の量のせいにしてしまうと、対策が的外れになります。読み手と目的を先に決める進め方は、年数に関わらず取り入れられます。
同じ「書けない」という状態でも、原因が違えば直す場所も変わります。文章の言い回しを直しても、読み手や目的が決まっていなければ、書きやすさは変わりません。
読み手と目的を先に決める進め方は、特別な準備や道具を必要としません。書き始める前に、この2点を言葉にする時間を数分取るだけで、書く範囲は絞られます。
2. 書けないと感じる場面ごとに、決まっていないことを整理します
「書けない」という状態は一つではありません。場面ごとに、何が決まっていないかを分けると原因が見えてきます。
場面と、決まっていないこと、先に決めることの対応
| 書けないと感じる場面 | 決まっていないこと | 先に決めること |
|---|---|---|
| 誰に向けて書くか浮かばない | 読み手 | 読む人を1人思い浮かべます |
| 何を書けばいいか絞れない | 目的 | 読んだ人にしてほしい行動を1つ決めます |
| 書き始めても手が止まる | 読み手はいるが目的が曖昧 | その文書で解決したい場面を1つ決めます |
| 書き終えても自信が持てない | 読み手にとって必要な範囲 | 読み手が知りたい範囲まで絞ります |
4つの場面はいずれも、文章の巧拙とは別のところでつまずいています。決まっていないことの種類を特定すると、次にすることが変わります。
誰に向けて書くか浮かばない場面では、読む人を具体的な1人に絞ることが有効です。部署名や役職ではなく、実在する人を思い浮かべると、書く内容が定まりやすくなります。
何を書けばいいか絞れない場面では、目的が複数のまま書き始めていることがあります。読んだ人にしてほしい行動を1つに決めると、書く範囲が絞られます。
書き始めても手が止まる場面は、読み手はいるのに目的が曖昧なまま書こうとしていることが多く見られます。この組み合わせは、一見準備ができているように感じられる分、原因に気づきにくくなります。
書き終えても自信が持てない場面では、読み手にとって必要な範囲を超えて書いていないかを見直します。書き手が知っている情報をすべて書こうとすると、読み手が必要とする範囲からずれていきます。
決まっていないことを洗い出す作業は、書く前に一度立ち止まるだけで足ります。時間をかけて分析する必要はなく、4つの場面のどれに近いかを当てはめるだけで十分です。
複数の場面が同時に当てはまることもあります。その場合は、読み手と目的のうち、より曖昧なほうから先に決めると、残りの判断もしやすくなります。
あわせて読みたい | Flaskの経験を転職で活かす|引き継いだアプリの話
3. 読み手と目的の2軸で、書けない理由を分けます
読み手が決まっているかどうかと、目的が明確かどうかを、2つの軸として並べます。
2つの軸を組み合わせると、書けない理由は4通りに分かれます。読み手だけ決まっている状態は、一見準備ができているように見えるため、原因が見過ごされやすくなります。
読み手も目的も決まっていない状態は、書き出しの段階でつまずきます。この状態は自覚しやすく、対処の必要性にも気づきやすいものです。
読み手と目的の両方が決まっている状態では、書く内容が絞られ、文章は自然と進みます。
目的だけが決まっている状態では、内容は書けても、読み手によって必要な詳しさや言葉づかいが変わるため、焦点がぼやけた文書になりやすくなります。
止まる型に当てはまる場合は、目的をもう一段具体的にすることが有効です。「共有のため」ではなく、「読んだ人が次に何をするか」まで言葉にすると、目的が定まりやすくなります。
空回り型に当てはまる場合は、目的は動かさず、読み手を1人に絞り直します。読み手が変われば、同じ目的でも書く詳しさや言葉づかいは変わります。
4つの型は、どれか1つに固定されるものではありません。同じ書き手でも、文書の種類によって当てはまる型は変わります。書く前に毎回見直す価値があります。
4. 読み手を決めて書く効き目を、転職の場面でも語ります
読み手を先に決めて書く効き目は、書いている最中だけでなく、書き終えたあとにも及びます。
転職の面接では、業務で書いたドキュメントそのものを提出する場面は多くありません。語れるのは、その文書を誰に向けて、何のために書いたかという説明です。
読み手と目的を決めて書いた経験がある人は、面接で聞かれたときに、その判断の理由まで言葉にできます。読み手を意識せずに書いた文書は、何を書いたかは説明できても、なぜその書き方にしたかまでは説明しにくくなります。
ドキュメントの書き方そのものよりも、誰のために書いたかを説明できることが、転職の場面でも効いてきます。
書いた文書の分量や見た目よりも、誰に向けて、何のために書いたかを説明できることのほうが、面接では伝わりやすい情報になります。
あわせて読みたい | データベースエンジニアの転職|運用の経験を設計に接ぐ
5. 書く前・書いている間・書いたあとの変化をたどります
読み手と目的を決めるタイミングは、書く前の1回だけではありません。
書く前に読み手と目的を決めても、書いている途中で対象がずれていくことがあります。段階ごとに立ち止まって確認すると、ずれに早く気づけます。
書く前の段階では、読み手を1人に絞り、何のために書くかを言葉にします。ここで曖昧なまま書き始めると、あとの段階で直す手間が増えます。
書いている間は、決めた読み手から内容が離れていないかを都度確認します。専門用語の使い方や説明の詳しさは、読み手によって変わります。
書いたあとは、決めた読み手の立場で読み直し、目的が伝わる内容になっているかを確かめます。書いた本人には自然でも、読み手には伝わらない書き方が残っていることがあります。
3つの段階のうち、書いている間の確認は見落とされがちです。書き始めた時点の読み手や目的から、途中で対象が変わっていないかを、区切りのよいところで確かめます。
3つの段階を意識するだけでも、書き終えたあとに大きく直す量は変わってきます。段階ごとに小さく確かめるほうが、書き終えてからまとめて直すよりも負担が軽くなります。
6. 読み手と目的を先に決める、3つの手順に絞ります
書く前に決めておく内容を、3点に絞って整理します。
書く前に決めておく3点
- 読み手を決める:文書を読む人を1人思い浮かべ、名前や役割で具体化します
- 目的を決める:読んだ人にしてほしい行動や判断を1つに絞ります
- 範囲を絞る:決めた目的に必要な内容だけを残します
3点はいずれも、書き始める前に決めておく内容です。書きながら考えると、途中で対象がぶれやすくなります。
読み手を決める際は、部署や役職といった属性だけでなく、実在する1人を思い浮かべると具体化しやすくなります。
目的を決める際は、読んだ人にしてほしい行動や判断を1つに絞ります。行動が複数思い浮かぶ場合は、優先する1つを選びます。
範囲を絞る際は、決めた目的に必要な内容かどうかを、項目ごとに見直します。目的に直接関わらない情報は、思い切って外す判断も必要です。
3点を順番に決めると、書く前の迷いが減ります。範囲を絞る前に読み手や目的が曖昧なままだと、何を外せばよいかの判断がつきません。
あわせて読みたい | ハイブリッド勤務の求人|「リモート可」では分からない出社頻度
7. よくある質問(Q&A)
Q1. ドキュメントが書けないのは、文章力が原因ですか。
A. 文章力よりも、読み手と目的が決まっていないことが原因である場合が多いです。読み手と目的を先に決めると、書き始めやすくなります。文章の言い回しを直す前に、この2点を確認すると、直す場所を見極めやすくなります。
Q2. 読み手が思い浮かばないときは、どうすればよいですか。
A. 実在する1人を思い浮かべると具体化しやすくなります。想定する部署や役割だけでも、書く内容の絞り込みに役立ちます。複数の候補が浮かぶ場合は、最も具体的にイメージできる1人を選ぶとよいでしょう。
Q3. 目的が複数ある場合は、どう扱えばよいですか。
A. 1つの文書に複数の目的を詰め込むと、焦点がぼやけます。目的ごとに文書を分けるか、優先する目的を1つ選ぶ方法があります。優先する目的を選ぶ際は、読んだ人に最初にしてほしい行動を基準にすると選びやすくなります。
Q4. 読み手と目的を決めても書けないときは、何を見直せばよいですか。
A. 決めた読み手にとって、その範囲が本当に必要かを見直します。目的に対して情報が多すぎる場合も、十分でない場合も、書きにくさとして表れます。見直しても書きにくさが残る場合は、目的そのものを1段具体的にし直すことも有効です。
8. まとめ:ドキュメントが書けないときは、読み手を先に決めます
この記事の要点
- 書けない原因は文章力ではなく、読み手と目的が決まっていないことです
- 場面ごとに、決まっていないことを1つずつ見分けると、原因が絞れます
- 読み手が決まっていても、目的が曖昧なままだと手が止まりやすくなります
- 書く前・書いている間・書いたあとの各段階で、読み手と目的を確認します
- 転職の場面では、書いた内容そのものより、誰に向けて書いたかを語れることが効きます
ドキュメントが書けないと感じたときは、文章の表現を直す前に、読み手と目的が決まっているかを確かめます。誰に何のために書くかが決まれば、書く範囲は自然と絞られ、書き終えたあとの見直しもしやすくなります。決めた読み手と目的は、書いている途中で見失いやすいため、区切りのよいところで思い出す習慣も合わせて持っておくとよいでしょう。
※公開中の求人数は時期によって変わります。記事中の求人の傾向は執筆時点のものです。
出典・参考情報
転職ノウハウ その他の記事
もっと読む 〉-
1on1で話すことがないとき|持っていく材料
1on1で話すことがないと感じる場面は、話す力の問題ではありません。日常の面談に何を持っていくかを、先に決めていないことが理由です。材料の置き場を先に決めておけば、担当や場面が変わっても同じ置き場を引き継げます。ここでは […] -
教えてくれる人がいない|聞ける仕組みを見る
教えてくれる人がいない職場かどうかは、求人票の文面だけでは判断しにくい点です。重要なのは教える人の有無そのものより、聞いたことが誰かから返ってくる仕組みがあるかどうかです。この仕組みは、面接や求人票の記載から確かめられま […] -
新人の教育を任されたとき|渡す順番
新人の教育を任されたとき、何から教えるかで迷う場面があります。ただし、必要なのは教え方の工夫ではなく、渡すものと渡す順番を先に決めることです。場所・仕事・判断・記録という並びで渡していくと、新人自身も次に何を渡されるかが […] -
同席を求められたとき|話す役目を確かめる
営業への同席を求められると、参加してよいかどうかで迷う場面があります。ただし、その場で自分が何を話す役目なのかは、面接や勤務先の上長との対話であらかじめ確かめておけます。役目が決まっていれば、当日の対応にも迷いにくくなり […]