わかりやすい文章の書き方

こんばんは。週末はいかがお過ごしでしたか？
私は順当に行けばあと2週間ちょっとで届くと思われるMacBook Proの環境構築について考えていました。クラムシェルモードを使ってデスクトップのように使うことを中心に諸々周辺機器について考えておりました。
さて、今日は私自身も課題に感じてはいますが、ドキュメント作成における文章の書き方についてです。
わかりにくいと思ったときの対処法としてどんなことを考えれば良いのか？文章を作っていく上でどういったことを考えれば良いのか？といったことを、私の経験なりにまとめてみたいと思います。

はじめに

先週下記の通り志望動機の考え方についてお話をしました。

ここでは物事の説明の仕方(どうして志望するのか？)といったことについて説明しましたが、このように文章を考えるときの前提になるようなお話が今日のトピックとなります。
私自身、仕事を通して他の人へ文章という方法を通して意見を伝えたり説明をしてきました。
Eメール、(本当はないほうが望ましいけど)謝罪文や再発防止策の説明文書、顧客へ納品したり社内での情報共有としての仕様書などなど。もちろん上にもリンクを再掲している志望理由についての書き方も相手への説明という意味では該当します。

今日のトピックでは以下のことが伝われば・・・と考えております。

・わかり易い文章を日本語で書くときのコツや考え方を理解する
・自分で文章を書くときに考え直すポイントがわかるようになる

私自身該当の文章を作成するときには、それなりに必要な知識をなるべく持つように心がけています。もちろん技術職の頃に書いていた仕様書関連の作成にあたっては、ネットワークや該当するアプリケーションやOSの知識等については前提条件から説明ができるよう事前に調べ自分なりにまとめるようにしていました。

例えばテクニカルライティングで大事なこと

色々な文書作成の例があるかと思いますが、例えばテクニカルライティングつまり技術文書の作成についてですと、この文書を作成する目的を考えてみてください。
ユーザがトラブルなくサービスやプロダクトを使うことができる、快適に使えるようになることだと思います。
そのように、ユーザに提供するサービスを正確かつ効果的にユーザに伝えるために、適切に文章を作っていくことを求められます。
また、私は情報は鮮度だと考えています。これは技術的な要素が新しいうちにという意味もありますが、読み手にとってタイムリーな情報になるかどうかであることが最も大事だと考えています。
なるべく速く書き、伝わるように書くことを意識しています。
テクニカルライティングでの一例をお話しましたが、次項からは文書の書き方として大事だと思う要素を一つずつお話します。

主語と述語を意識する

話をしているとあまり意識しないことがあるかもしれませんが、文書を書くときには、主語と述語を意識するようにしています。
例えば以下のような文章があったとします。

左側の黒背景の文章は、1文にまとめて表現をしているのが伝わります。ただ、主語と述語を意識していないのでシステムの説明だけにとどまります。
一方右側の青背景の文章は、文章を2つにわけているもののシステム全体についての説明を1.で行っています。その1.について読み手であるユーザの立場から、ユーザが実際に使う時、つまりユーザが主語になる場合の文章を作成していることがわかります。具体的にユーザの立場でどういった効果が期待できるのか？(業務を効率化できる)についてちゃんと書いています。

2つ目の例としては主語と述語の距離についてです。

左側の黒背景の文章と右側の青背景の文章を比べてみると、書いてある意味は同じであることは伝わるかと思います。ただ、文章の主語が冒頭にある黒背景の文字は主語がどうなるのか？といった述語部分が最後にあるため、最初から全て読まないと伝わりにくいです。一方青背景の文章は主語のすぐ近くに述語が書かれているので、文章を全て読み理解をしていなくても要所要所で理解しやすいと言えるでしょう。

文を短くする

同じことを説明するための文章でもなるべく短く区切っていけるかどうか？を大切にしています。先程の主語と述語を近くするということもありましたが、主語と述語が近く文章をなるべく区切るという形でなるべくわかりやすくするべきであると思っています。

黒背景の文章は一文が長いです。「し」で区切ることで、1文に詰め込みをしていることが伝わるでしょう。一方青背景の文章は「。」で区切っています。つまり一つの流れが完了していることがわかります。サッカーやバスケで言う「シュートで終わる」のような表現がしっくり来るかもしれません。キリが良いので読み手も優しいと感じることでしょう。同じような事例として「ので」で文章をつないで文章を長くすることも知らず識らずのうちにやってしまうかもしれないので、注意すべきです。私も下書き時によくこのようなことをやってしまうので、なるべく箇条書きで最初は書くようにしています。

2つ目の例は表を使った例についてです。

大会の説明をイメージしてみましたが、言いたいことが多いのが伝わるかと思います。黒背景の文章はとにかく大会について文章で表しているのに対し、青背景の文章は概要をなるべく文章を区切るようにした上で、
各賞についてわかりやすい比較もできるよう表にしていることがわかるかと思います。このように箇条書きや表を使うことで情報を整理するということも大事なことだと考えています。

その他の注意事項

その他の注意事項としましては、例えば複合名詞や造語を避けるようにしています。読んだときにすんなり頭に入りにくい単語、例えば「本人確認書類郵送」を「本人であることを確認するための書類を郵送する」というように、複合名詞や造語はなるべく避けるようにしています。確かに複合名詞や造語は文章を伝える側としては圧縮できるので便利なのですが、受け手のほうがそれを正しく受け取り正しく理解してくれるのか？と考えたときに、なるべく齟齬が発生しないよう、複合名詞や造語は避けるべきだと私は考えています。

その他にも、私は以下のことについて意識をするようにしています。

・同じものは同じ名前で呼び、違うものは違う名前で呼ぶ
　プロダクトになったり製品になったりデバイスになったりしない
・接続詞など、よく使う言い回しは限定する
　順接: 前の事柄が原因や理由となり、あとの事柄が結果、結論となる
　　- だから、それで、そのため、このため、そこで、したがって等
　補足に使う接続詞
　　- なお、ただし、ただ、もっとも、実は等

また、安易に強調はしないようにし、簡潔にするように心がけています。

ログインするには、IDとパスワードを入力する必要があります。

これを、

ログインするには、IDとパスワードを入力します。

といった形になおすようにしています。

また、安易に強調しませんが自信を持って書くようにしています。

お使いのアカウントで設定が有効になっていない可能性があります。設定を有効にするには、アプリケーションの設定画面から[適応]をクリックします。

こういった文章もエラーにつながる内容なので、

お使いのアカウントで設定を有効にしてください。設定を有効にするには、アプリケーションの設定画面から[適応]をクリックします。

このように自信を持って設定方法についてまとめるように心がけています。

また、なるべく二重否定が発生しないよう心がけています。二重否定になると文章全体がわかりにくくなることが多いからです。

△: アドオンを追加していないと、Bluetoothプラグインは有効化できません。
○: アドオンを追加すると、Bluetoothプラグインを有効化できます。

最後に

わかりやすい文章を日本語で書くときのコツや考え方についてお話させていただきました。ご自分で文章を書くときに、考え直すポイントについてご理解いただければ幸いです。
・主語と述語を明らかにする
・文を短くする
その他に、誤解されないよう語順に気を配ったり、前提知識が必要な場合は読み手の知識レベルについても気を配ることが大切だと思います。

関連トピックとしてこのようなものがありますので、もしよろしければご一読いただければ幸いです。
また、実践事例(内容は少し変えて)を交えながら、こちらの投稿の続きについても機会があればお話したいと思います。

最後までお読みいただきありがとうございました。
今週も一週間よろしくお願いいたします。