読みやすい文章を書くために工夫していることはありますか？ – DevelopersIO 著者のみんなに色々聞いてみた Advent Calendar 2021

アドベントカレンダー2021

しんや

2021.12.14

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

当エントリは『DevelopersIO 著者のみんなに色々聞いてみた Advent Calendar 2021』14日目のエントリです。

当エントリでは、今年2021年のアドベントカレンダー企画として、『読みやすい文章を書くために工夫していることはありますか？』のアンケート集計結果について紹介していこうと思います。

Q. 読みやすい文章を書くために工夫していることはありますか？

先日までに紹介した「校正」「構成」と被る部分はありますが、全体的な記事のブラッシュアップ手段として「もっと読みやすく改善する術は何かあるか？」というニュアンスで今回の質問は設けてみました。

以下、回答内容をカテゴリに分けて紹介します。

A1. 想定読者を定める

まずはこちら『想定する読者を定める』について。記事を届けたい読者、どういう層の読者に対して読んでほしいか、その部分をまずは定めることでどのような内容で文章を届けるかどうかの方向性をある程度絞ることが出来ます。逆に言うと、この部分がブレてしまうと中々厳しい結果になってしまうことは想像に難くないかなぁ、という感じがしますね。

・読み手のレベル感を想像する
・想定読者をよく考える。だいたいこれくらいの知識はあって、
　この辺の知識はない人みたいなことを考えて、
　前提となる知識は大幅に省略して知識が薄そうな部分は丁寧に説明する。

A2. 構成を決める

エントリ1本をどのような構成にするか、というのもとても大事なポイントです。ゴールを定めてそこにどういう展開で持っていくか、起承転結、問題提起と課題解決、その他様々な議論が「構成を決める」という点だけでも出来るのではないでしょうか。

・章立てを最初に決める。
・そのエントリで一番言いたいことに向かって読者が自然に興味を持つような構成にする
・最初に結論を書いたり、文書構成に一貫性を持たせたり
・Markdown のアウトラインで全体構成を考えてから書いてる
・章立ての粒度は適切か？
・「てにをは」に気をつける、ストーリを考える（ハッピーエンド）
・はじめにwhy, whatを書くようにしています
・このブログで何を話したいか（ゴール）
・長くなりそうならTL:DRを頭に書いたり、結論から先に書いたり
・ブラウザの1画面が文章だけで埋まらないような画像や章タイトルなどの配置

A3. 文章の書き方に気をつける

ブログエントリ全体も解していけば1文1文の集まり。ということは文章1つとっても読みやすい形でないといけないと思います。「適切な長さで」というコメントが多くあるのも「短く簡潔に言い切っている文章は分かりやすい」という認識があるからなのだと思います。

・一文を長くしない
・なるべく文章を短く書く
・長文にしない。
・同じことを伝えるのならできるだけシンプルに。1文を短く。
　細かな点は結城浩先生の「数学文章作法」を参考にしている
・1つの文が長くならないようにする。
・全体的に１つの文の長さが過剰にならない様には一応気を付けています。
・1段落1テーマ、1文を短く、主語と述語の対応付をしっかり、箇条書きは短く言い切る、
　最初に結論の後に深堀り、などなど論文を書くときの注意点とほぼ同じ
・１文が長すぎないように
・文章の長さが冗長になっていないか？
・一文をなるべく短くする
・一つの文章を長くしない、箇条書きできるところはする
・「〜ます」などの文末が同じものが繰り返されないようにする
・漢字を開く＆開かない

A4. レイアウト・体裁を確認する

文章そのものが良くても、レイアウトや体裁で望ましくない形になっていると記事の魅力も損なわれてしまいます。読みやすさと合わせて「見やすさ」なども気を付けていきたいですね。

・段落、改行、半角スペースを適切に入れる
・行間を空ける
・良きところで改行を入れる
・バランスを考えて太字にする
・改行位置や句読点位置

A5. 説明を入れる

読者はその記事内容に精通している訳ではないので、いきなり専門用語が出てくると面食らうかもしれません。この辺は想定読者をどこに置くか、というのにも拠るかと思いますが、適宜専門用語に関する説明や、その説明が分かるような補足資料が展開されていると記事の理解のし易さも格段に向上すると思います。

・一般的でない略語や業界用語は控える。
・専門用語を減らす（書かざるを得ない時は書く）
・自分のわからない（説明できない）ことは書かない。
・やってみた系の記事であれば前提条件の解説をどこまでするかに気を配ってます。
・技術的なキーワードは最初に説明を入れる
・単語のブレをなくす。
・文章で無理に説明しようとせず、必要に応じて図表での解説を検討する。
　文章と図表で役割を分けることで、結果的に一文は短く、読みやすくなると考えている。
・ハイコンテキストにしない。（できるだけ）何に困っているかや
　何を解決したいのかを初めに書く。
　エントリで触れるサービスやツールについては、
　「〜とは」章を入れてわかりやすくする。

A6. 図を入れる

文章だけでは分かりづらい内容を、図や画を追加することで内容を理解しやすくする...というのも素晴らしいテクニックです。

・理解しづらいところは図を描く
・図を添えたり
・文章だけにならないよう、図を入れてイメージしやすくする
・図で補足する

この点に関して、私個人的には千葉(幸)さんのブログで出てくる解説図が最高だなーと思っています。複雑で分かりづらいAWS IAMのあれやこれやが千葉(幸)さんのブログを介するとスッと内容が入ってきます。

A7. 記事を読み返してみる

先日の「校正」に関する内容でも言及しましたが、「内容を読み返してみて、より良く分かりやすい、読みやすい文章に変えていく」というのも十分有効かつ適切な手段です。

・ロジックが成立しており、ストレスなく読み進められるかどうか。
・自分で読んでみて引っ掛かる点がないようにしてます
・声に出して読んで違和感ない文章に校正する。
・内容によりますが、掲載まで1日空けて再度読みなおす
・何回か読み直す中で、列挙の階層はどうか？流れが悪くないか、
　冗長な表現はないか？など修正していきます
・喋ってみて違和感が無いこと、一文が長くなりすぎないこと、
　列挙する時は箇条書きを使う、
　文章で伝わりにくい時は図を使う、MECE
・音読をしてみて話の繋がりに違和感がないか確認する。
・公開直前のセルフレビューの際に音読してみている。一文を読み上げている間に、
　主語や述語が自分の頭の中で整理できなくなったら、改善の余地ありと判断している。
・コンテキストを排除してレビューする

A8. 情報を参考にする

先人の知見を参考にする、というのも大いに有効な手段です。

・他の人の文章をたくさん読むよう心がけ、インプットを増やしている。
　いいなと思った表現を積極的に真似ていく。
　(技術ブログに限らず、ビジネス書籍なども参考になる)
・書籍を参考にする：
　・図解でわかる! 理工系のためのよい文章の書き方論文・レポートを自力で書けるようになる方法 | Amazon https://www.amazon.co.jp/dp/4798158895
　・数学文章作法基礎編 (ちくま学芸文庫) | Amazon https://www.amazon.co.jp/dp/448009525X

回答として頂いた中で紹介されていた書籍のリンクを以下に展開しておきます。こちらも気になる方は読んでみてはいかがでしょうか。