この記事は、CYBOZU SUMMER BLOG FES '25の記事です。
こんにちは、kintone 新機能開発チームでフロントエンドエンジニアとして働いている 25 卒の江﨑です！早いものでチームに配属されて 4 ヶ月が経とうとしており、出来ることを増やしながら食らいついている毎日です。
今回は、「新卒エンジニアが学んだ、伝わりやすい文章を書くための実践ポイント」を紹介します。 初歩的な内容が多いかもですが、自分と同じ新卒の方やこれからチームに入る方の参考になれば嬉しいです。
配属されて感じた、文章を書く機会の多さ
恥ずかしながら IT エンジニアという職業上、仕事で文章を書く機会はそれほどないと思っていました。というのも、今までは個人開発が中心だったので自分が理解できればいいというスタンスで、文章を書くことにあまり意識を向けてこなかったからです。
しかし、配属されてからはチーム内での ADR（意思決定記録）作成や、他チームへの技術的な問い合わせ、AI への実装指示など、文章を書く機会が思ったより多くあるように感じました。
私自身、文章を書くのが苦手ですが、ライティングに関する研修や上司からのアドバイスをもとに、学んだことを共有したいと思います。
ライティングに関する研修資料は以下に掲載しておきます。あわせてご覧ください。
伝わる文章を書くための原則
文章を出来るだけ少なくする
これが一番大切だと感じています。後述するテクニックも、この意識があってこそより効果を発揮します。
「読んで理解してもらう」の前に、「読んでもらう」の壁がある
どんなに伝わりやすい文章を書いたとしても、文章量が多いと読むのを後回しにされてしまうことがあります。長文のメッセージが届いたとき、読むのが億劫で後回しにしてしまうのは、きっと私だけではないと思います。
だからこそ、文章量をできるだけ少なくして、読むハードルを下げることが大切です。
「そんなの当たり前じゃない？」と思うかもしれませんが、私自身、もっと詳しく書いたほうが伝わるかなと思って、ついダラダラと長く書いてしまう癖がありました。そのため、むやみやたらに長い文章にならないよう気をつけるようにしています。
文章を少なくするために考えるべきは「読み手のメンタルモデル」
- メンタルモデルとは、認知心理学で使われる言葉で、「すでに持っている知識やイメージ」を指します。
- 文章で伝えた情報と、読み手のメンタルモデルが結びつくと、文章に書いていない部分も自然と頭の中で補完してくれます。
例えば、「このチームの人ならこの知識は説明しなくても分かるな」とか、「読み手がエンジニアではないから前提知識を補足しよう」といった具合に、読み手のメンタルモデルを想像して、必要な情報を取捨選択することが重要です。
こうすることで、文章量を減らしつつ、必要な情報はしっかり伝えることができます。
伝わる文章にするテクニック
タイトルを読むだけですべて理解できるを目指す
上記の原則でも触れましたが、伝わりやすい文章にはメンタルモデルに合わせた情報展開が必要になります。文章の内容を推測できるようなタイトルをつけることで、読み手のメンタルモデルをこちらでコントロールすることができます。
画像や動画などのメディアを文章に交える
大抵の事象は文章だけで説明することが可能ですが、無理にそうする必要はありません。メディアを積極的に使うことで文字数を減らせたり、直感的に理解しやすくすることができます。
文章を構造化する
項目ごとに分けて書くことで、文章全体の流れが明確になり、読み手が迷わなくなります。
▪️構造化しない場合
プロジェクトの進捗状況についてですが、現在の進捗率は50%です。課題としては、デザインの最終確認がまだ終わっていないことと、APIの仕様変更が発生したことです。これらが原因でスケジュールが少し遅れています。
▪️構造化した場合
プロジェクト進捗状況
- 現在の進捗率: 50%
- 課題:
- デザインの最終確認が未完了
- API の仕様変更が発生
- 影響: スケジュールが少し遅れています
おわりに
改めて振り返ってみて、読みやすい文章を書けるようになるのは一朝一夕で身に付くものではないと感じました。生成 AI を使うことで読みやすい文章を作成する助けにはなりますが、「何を伝えるか」は自分で判断する必要があります。普段の業務でも変数名や関数名、プルリクエストのタイトル、コミットメッセージなど、最低限の文字数で意図を伝える機会は多いので、意識して身につけていきたいと思います。
