LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた

こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。

そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。

この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介しています。

どれくらい大評判だったかというと、2日間4セッションでしたが、エントリー数はのべ1000人を超え、実際の参加人数はのべ約900人。アンケートの回答は以下のとおり、のべ454人。そして、アンケートに答えてくれた全員が「期待以上に面白かった」または「面白かった」と答えてくれました。正直、「面白くなかった」「期待外れだった」が0だったことに驚きました。

※ 1人の人が複数のセッションに参加できる仕組みになっていたので、アンケート回答数は、のべ454人、実人数269人となっています。

そんな大評判の講義のうち、6/2に話した第一弾の内容をもとに、この記事を書きました。

こういう流れになっています。

  • 文章のバリエーションを素早く作りましょう
  • 主語と述語を明らかにする
  • 文を短くする(ので、し、を敵視する)
  • 文を短くする(箇条書き、表を使って情報を分断する)
  • 語順に気を配る
  • 読み方を工夫しなくてもわかる文章を書く
  • 前提知識が必要な場合は注意する
  • Tips
  • まとめ
  • お願い

こういう文章で一番大切なことは期待値調整、と聞いたことがあります。この文章を読んだら、どんなメリットがあるのかというのを明確にしておきましょう。

本当に凄腕のテクニカルライターなら息をするようにわかりやすい文章を書けるかもしれませんが、私はそうではありません。そういうわけで、この記事を読んでも「息をするようにわかりやすい文章を書くコツ」はわかりません。

そうはいっても約20年くらい続けてきたテクニカルライターです。長く続けてきた結果、今回みなさんと共有したい、あるコツを身に着けることができました。

私が身に着けたコツは「文章のバリエーションを素早く作ること」でした。この記事では、これをどのように行うか、ということを例を少しずつ挙げて説明していきます。

この記事を読んだあなたが「なるほど、自分が文章を書くときに使えるぞ」と思ったり、「ブックマークしておこう」とか「これは同僚に伝えなければ!」と思ってシェアしたりすることを狙っています。最後まで読んだあとで、どんな感想を持ったのか、ぜひTwitterで教えてください。

文章のバリエーションを素早く作りましょう

私が身に着けたコツは「文章のバリエーションを素早く作ること」でした。この記事では、これをどのように行うか、ということを例を少しずつ挙げて説明していきます。

少し具体例を交えて、バリエーションを作ることについて説明しておきましょう。

私たちLINEのテクニカルライターが書いているドキュメントに「LINEログインの概要」というページがあります。

このページは、WebアプリやAndroidアプリ、iOSアプリの開発者が自分のアプリで、「LINEログイン」という機能を利用するときに読んでもらうためのページです。

実際に見ていただくと、こんな文章があるのが目につくはずです。

この文章を追加した経緯をサッと説明しておきましょう。

以前は、Googleなどの検索エンジンで「LINEログイン」という単語で検索すると、今まさに見ていただいたページが表示されていました。そして、このページに対して寄せられたフィードバックを見ていると、どうやら開発者の方ではなく、LINEアプリでログインできなくなったユーザーがこのページに迷い込んでいるということがわかりました。そこで、ユーザーの人たちに向けて、ここはあなたたちが来るべき場所ではありませんよ、ということを伝えるために追加した文章です。

少し前振りが長くなってしまいました。そして、少しわき道にそれたので元の道に戻ってきましょう。

ここでは、「文章のバリエーションを作る」というのはどういうことか、という話をしようとしています。上の文の別案を、いま思いつくままに書くと、以下のようなパターンで書くことができました。

  • これは、開発者用ドキュメントです。LINEアプリの使いかたについては、ヘルプセンターを参照してください。
  • ここでは開発者向けの情報を提供しています。LINEアプリへのログイン方法については、ヘルプセンターを参照してください。
  • LINEアプリの使いかたは、ヘルプセンターを参照してください。
  • LINEログインを組み込む方法を説明したドキュメントです。LINEアプリにログインできない場合の対処方法は、ヘルプセンターをご覧ください。

これくらいのパターンなら、息をするように書けるようになりました。でも、一文一文を読んでみると、どの文章も本当にわかりやすいか、というと大分疑わしいですね。

つまり私は「息をするようにわかりやすい文章は書けない」でも「息をするように文章のバリエーションを作れる」というスキルを持っているということがわかっていただけると思います。

そして私たちのチームではわかりやすい文章について困ったとき、「この文章がいいんじゃないか」「こっちの文章とあっちの文章を組み合わせたらもっとわかりやすいんじゃないか」といったことを、自問自答したり、チームメンバーと相談したりして、わかりやすい文章を作っていきます。

今あげた例では、このような文案の中から「これは、開発者用ドキュメントです。LINEアプリの使いかたについては、ヘルプセンターを参照してください。」が、最も必要十分な情報を提供できていると判断し、掲載しているというわけです。

私が文章を書く流れをまとめると、こうなります。

これが私が身に着けたコツです。私は、この方法を使えば、テクニカルライターだけではなく、だれもが文章を改善できると考えていますので、ぜひこの記事を通してコツを盗んでいただけると幸いです。

前振りが思いのほか長くなってしまいましたが、この記事では「いかに悪くない文案を考えるか」や「1つの文章を作ったあとで、いかに新しい文章を作成するか」という例をいくつかあげ、最後に「一番いい文を選択する」ことが大切だぞ、という話を何度もします。それが「文章のバリエーションを素早く作ること」につながると信じています。

どれが一番いい文章なのかは、状況や、読者層、執筆者や査読者の好みによりますので、この記事では触れません。ご了承ください。

主語と述語を明らかにする

それでは、ここから具体的にどのようにして文章のバリエーションを作っていくか、という話をしていきましょう。

まずは主語と述語を気にすることで、別の文案を作れますよ、という話からです。ここでも私たちが書いている文章から事例を持ってきますが、前提がわからないとうまく伝わらないと思うので、前提を説明させてください。

LINEではMessaging APIという仕組みを提供しています。これを使うと、誰でもLINEで動くボットを作成できるという大変面白い仕組みです。

ただし、Messaging APIを使ってボットを作成するには、LINE公式アカウントが必要です。自分個人のアカウントで、自分の代わりにボットに答えてもらう、みたいなことはできません。

さて、そのMessaging APIに「クイックリプライ」という機能があります。ひょっとしたら、みなさんもこのようなボタンを見たことがあるかもしれません。

(一番下に表示されているボタンが「クイックリプライボタン」です)

Messaging APIでは、ボットから「クイックリプライボタン」を設定したメッセージを送信することで、このような返信用のボタンが表示される仕組みを提供しています。

そして、私たちが提供するドキュメントに「クイックリプライを使う」というページがあります。やっと本題にたどり着きました。

反転した一文に注目しましょう。私はこの一文を改めて読んでみたところ、小さな違和感がありました。主語と述語があやふやな気がしたのです。

すべての述語に対して主語が明らかになっているか、また主語(つまり登場人物)が隠れていないか、というところを見直すために、この文章の後に続く説明内容も含めて、一連の流れを見直してみました。すると、この1文で言いたいことには、3つの主語が隠れていました。

  1. レストラン検索ボットがクイックリプライボタンを表示する。
  2. ユーザーがクイックリプライボタンをタップする。
    すると、ユーザーの要望がレストラン検索ボットに伝わる。
  3. このようなクイックリプライボタンの具体例を、(私たちがJSONデータで紹介しますので、一緒に)メッセージを作成してみましょう。

これを省略せずに、文章で表現してみると、新しい文章ができあがります。今回は以下のようにしてみました。(私たち)のところはこういう文章なので書かなくてもよいと思います。また、書き換えてみたところ次の文とのつながりが悪くなったので、最後の文もアレンジしています。

文章は長くなっていますが、何を言いたいかは明確になっています。元の文章とどちらがわかりやすいかはさておき、新しい文章ができあがりました。これを出発点にして、さらに新しい文章を考えていけば、もっと文章を作れるでしょう。

ここでは「主語と述語を明らかにする」例を紹介しましたが、主語と述語に関しては、以下のような手法もあります。

手法説明
主語と述語を意識する思いつくままに文章を書いていると、主語と述語がねじれてしまったり、主語が正しく伝わらないことがあります。
一度書いた文章を読み直すときに、主語は何か、述語は何か、それぞれ明確であるか、ということを意識しながら読みましょう。
ここでまた、私たちが書いている文章から引用しましょう。「LINE SDK for Androidの概要」に、「ユーザーがログインすると、ユーザーのLINEプロフィールを取得できます。」という文章がありました。
これは実は「(LINE SDK for Androidを組み込んだアプリは、)ユーザーがログインすると、ユーザーのLINEプロフィールを取得できます。」ということを言いたいのですが、元の文章では、主語が正しく伝わらずに、意味が分からない文章になっている可能性があります。
主語と述語の距離を確認する上で紹介した新しい文案「(LINE SDK for Androidを組み込んだアプリは、)ユーザーがログインすると、ユーザーのLINEプロフィールを取得できます。」について、もう少し考えてみます。
主語は「アプリは」、述語は「取得できます。」ですね。この2つの距離が遠いかもしれないので、近づけて新しい文章を作ってみましょう。
「ユーザーがログインすると、LINE SDK for Androidを組み込んだアプリは、ユーザーのLINEプロフィールを取得できます。」
これでまた新しい文章ができあがりました。

このようにして、バリエーションを作っていきましょう。

なにかモヤっとした違和感がある文章になってしまったときに、主語と述語に注目するのはとても良い方法です。ぜひ試してみてください。

そして文章を書くときには、いくつかの文案(バリエーション)を書き、その中から良さそうなものを選択することで、わかりやすい文章を作っていくという姿勢がとても大切で有効であることを忘れないでください。

これで、1つ目の主語と述語を明らかにする話はおしまいです。

文を短くする(ので、し、を敵視する)

文が思いのほか長くなって、わかりにくくなってしまうことがあります。文章に「ので」とか「し」が入っている場合に、そこで2文に分割できるよ、という話をします。

これも、私たちが管理しているLINE Developersで「LINEログイン」というのはこういうものですよ、ということを紹介しているページに書いてある文章です。読んでみたときに、頭の中に次から次に情報が放り込まれ、情報が積みあがっていく感覚になったと思います。図にするとこんな感じです。

このようなときに、多くの人は「わかりにくい」と感じます。この文章で使われている「ので、」が原因になっていることが多いです。「し、」も同じようにわかりにくい原因になりがちです。

どちらも2つの文章を接続するために使われる便利な語句です。ただ、ほとんどの文章でこのような言葉を使う代わりに「。」を使って区切ることができます。試しにやってみると、こうなります。

読んでみると、頭の中に情報が積みあがっていく感じが少ないと思います。図にすると、こうです。

そして、若干わかりやすく感じたのではないでしょうか。ほとんどの人は、文章を読んだときに「。」がくると、一回頭の中をリセットできます。「ので、」や「し、」を使って1文が長くなるにつれて、頭の中に積みあがる情報が多くなります。逆に「。」で区切って1文を短くすると、頭の中に積みあがる情報が少なくなります。その結果、わかりやすく感じることになります。

どちらがわかりやすいかは別にして、これでまたバリエーションができたことになりますね。

ただ、改めてみると何か違和感がないでしょうか。実は、この文章も主語と述語があいまいです。主語と述語があいまいなことを、「ので、」で文章を長くしてごまかそうとしているようにも見えます。

主語と述語を意識して、文章を書き換えてみましょう。

思いのほか文章が長くなってしまいましたが、これでまたひとつ新しい文章ができあがりました。

大事なことなので何度でも書きますが、文章を書く上では、いくつかの文案を書き、その中から良さそうなものを選択することで、わかりやすい文章を作っていくという姿勢がとても大切で、とても有効であることを忘れないでください。

文を短くする(箇条書き、表を使って情報を分断する)

伝えたいことがいっぱいあって文が長くなってしまうことも良くあると思います。

以下の文は、LINE BOOT AWARDS 2018の記事に書いてあった文章です。LINEのTechnical Evangelist 立花さんが書いた記事から、ちょうどいい例を借りてきました。

言いたいことがいっぱいあって、勢いを伝えたいという強い意図を感じる文章ですね。初めから終わりまで必ず読むであろうブログで使えるいい表現だと思います。

一方、この勢いを真似てビジネス文書で長い文章を書くことは嫌がられますよね。そこで、箇条書きと表を使って、1文を短くしてみましょう。

よくよく見比べるとわかりますが、情報量が減っていません。ただ、ちょっとわかりやすくなったのか怪しい気がしますよね。

実はある特定の状況では、非常にわかりやすくなっているので、どういうことか説明しましょう。

何かしら目的をもって情報を探しに来た読者の気持ちになってみてください。

  • たとえば、「優勝賞金」を知りたい読者になってみましょう。
    どちらの文章でも「最大1,000万円」ということが簡単に読み取れたと思います。これは、賞金ということは数字で書いてあるだろう、という想像ができ、そのとおり数字で書いてあるからです。これについては、元の文も変更したあとの文もほとんど差がないでしょう。
  • 次に、優勝以外にどのような「賞」が設けられているか知りたい読者になってみましょう。特別な賞を狙ってコンテストに応募するのは良くあることだと思います。
    では、元の文章をあらためて読んでみて、すべての賞を読み取れた、という確信を持てるでしょうか。何度も同じところを読み直して確認したくならないでしょうか。ひょっとしたら賞が見つかったら、どこかにメモをしながら読み進めているかもしれません。
    書き換えたあとの文章では、表を見るだけで、的確にどのような賞があるか読み取れた!という自信をもてると思います。前の文章より「わかりやすい」と感じると思います。別の言い方をすると、これは「すでにメモされている状態」とも言えますね。

このように、読者によっては一部の情報だけが必要であること、また、必要とする情報が異なるということを覚えておいてください。

そのような要求にこたえるためには、箇条書きや表はとても有効な方法です。ただ、盲目的に、常に箇条書きや表を使うべきと考えないでください。いったん箇条書きや表で書いたうえで、もとの文章と比べて、どちらが良いか選択することがとても大切です。

複数の文案を比べて選択することは、ここまでに何度も出てきていますので、だんだんこの記事で言いたいことが見えてきたのではないでしょうか。

語順に気を配る

単語を並べるだけでは、言いたいことを的確に表すのは無理だから気をつけてね、という話をします。これも最後には、複数の文案を作って比較する話につながります。そのつもりで読んでください。

ひとつ例題を見てみましょう。登場する単語は「いろいろ」「漢字」「読み方」の3つです。

左側の例文では、複数のいろいろな漢字を列挙して、それぞれの読み方を1つ2つ紹介しています。

右側の例文では、漢字を2つだけ挙げて、複数のいろいろな読み方を紹介しています。

意味が変わっていることがわかると思います。

「きれいな花の絵」と「花のきれいな絵」も同じように、異なるイメージを持たせることができると思います。

どちらも正しい日本語です。どちらの意図で文章を書いているのかは、文章を書いているあなたにしかわかりません。正しく意図を伝えるために、語順に気を配ってください。

ここまでは良くある話です。この記事では半歩進んで、文章を書くときに「語順に気を配る」ことが大切なことを、違う方法で説明しておきましょう。

私は、文章を書くときに、頭の中に言いたいことが「文章の形で」滑らかに浮かぶことはあまりありません。ほとんどの人も私と同じように「単語が断片的に」頭に浮かぶのではないでしょうか。

上で紹介した例文の場合は、「いろいろ」「漢字」「読み方」が頭に浮かびます。これらの単語を、深く考えずに助詞を使ってつなげると、ときによって「いろいろな漢字の読み方」になったり、ひょっとしたら「漢字のいろいろな読み方」になったりします。私はこの方法を否定しません。そういうものなのです。

では、どうやって正しい語順、つまり自分が意図した分の意味になる語順にするか、というのが気になるところだと思います。

私は文章を書いてから、少しでも心配な部分があったら、意図的に単語の順番を入れ替えてみます。

そして、実際に伝えたいことをイメージしたうえで、初めに書いた文章と、単語を入れ替えた文章を読み比べ、そして、うまく意図が伝わりそうなほうを選択します。

ここでも、文章を複数書いて、良さそうなほうを選択する、という話にたどり着きましたね。

読み方を工夫しなくてもわかる文章を書く

これは社内の講義では説明しなかったことです。社内の人たちも一定数読んでくれているといいなーと思って、新しい内容を書いておこうと思います。

悪い例を、私たちが提供するFAQから探してきました。以下のQの文を取り上げます。

パッと見では良く分からないと思いますが、Qの文を良く読むと「メッセージIDはどの単位で一意ですか。」が疑問であることがわかります。

これを書き換えてみると、実はこういう感じです。

元の文章を書いたときは文章構造を理解しているので、「/」で区切るだけで十分伝わると判断したのですが、改めて読んでみるとこの文章構造を読み取るのはなかなか難しいことでした。

この問題を、文章を書いているときにどのように検知すればいいでしょうか?

私は、書いた文章をただ読み直すだけでなく、誰かに理解してもらおうと読み直してみることをお勧めします。

もっとわかりやすく伝えようと何度か読んでいるうちに、どういうわけか自然と、緩急をつけて読んだり間をあけたりすこし強調して読んだり、いずれにしても何か読み方を工夫するのではないでしょうか。

読み方を工夫した時点で、読者に伝わらない可能性が非常に高くなっていると判断してください。

なぜなら、文章は楽譜ではないので「ここを早く読む」とか「ここはゆっくり読む」、「ここを強調する」などということを正しく表現できないからです。「」などの記号や句読点(、。)を駆使して、情報の区切りを伝えることはできますが、読み方を伝えるために記号を多用するなら、他の文章を考えたほうが良さそうです。

この例ならややこしいことは言わずに、以下のようにバサッと詳細を省いてもFAQの役目を果たせると判断しました。

ここで言いたいのは、新しい文案が適切かどうか、ということではなく、どのようにわかりにくい文になっていることを検知するか、という点でした。

具体的には、文を読みなおすときに緩急をつけるなど、読み方を工夫したくなった場合は、新しい文章を考えるタイミングと思ってください、という内容でした。淡々と読んでも理解できる文章を目指して文案を作り続けましょう。

前提知識が必要な場合は注意する

徐々に、わかりやすい文章の書きかたの根底にある「たくさんの文案を書いてより良さそうなほうを選択する」というルール、そして、どうやったら、問題がありそうな文になっているかを検知できるか、というノウハウが理解できてきたころだと思います。

ここで、このルールから離れたかのようにも見える、とても大切なことを説明しておきましょう。

それが「前提知識が必要な場合は注意する」です。私がいつもやる講義では、天気予報で良く使われる「曇り 時々 雨」と「曇り 一時 雨」の例を挙げて説明しています。

この2つの言葉は、実は雨が降る時間によって使い分けられています。どちらが長い時間、雨が降るかわかりますか?

これがわかるのは、気象予報士と、一部の天気予報好きだけだと私は思っています。実際、社内の講義で聞いてみると、ほとんど半々にわかれます。「時々」と「一時」という言葉だけで、時間の違いを感じるなんて、もともと無理な話なのです。

ですが、気象庁ではきちんと定義され、使い分けられています。

引用:https://www.jma.go.jp/jma/kishou/know/faq/faq4.html#2

図にすると、こういうことです。「時々」のほうが雨が長い時間降っているそうです。

このように、情報を提供する側はきちんと言葉を定義して使い分けていたとしても、それが受け手に正しく伝わらないことは、よくあります。あの気象庁が使う言葉ですらそうなのですから、私たちがやらないわけはありません。

みなさんに注意して欲しいこと、そしてぜひやって欲しいことは、「その言葉、その表現が、知り合いにしかわからないのではないか」を、文章を書いたあとにもう一度考えてみることです。

もし読者が理解できるか疑わしいのであれば、その言葉、その表現の意味をどこかで説明しておきましょう。

逆に、読者が常識的に知っていることを、懇切丁寧に説明することもまた問題です。

たとえば、BTSと書けば「Bug Tracking System」のことであるとわかり、それが何か理解できている人たちに向けて、Wikipediaの「BTS」や「バグ管理システム」で書かれているような説明を始めるのが正しいとは言えないでしょう。

やはり大切なことは、文案をいくつか書いて選択することなのです。こういう言葉の定義については、一人で判断するのではなく何人かで判断するほうが良いと思います。

Tips

社内講義では、ここからさらに細かい話が続くのですが、インターネットで「わかりやすい文章の書きかた」を検索すると、山ほど出てくると思いますので、この記事では省略することにしました。

それから、ちょっと古い本ではあるのですが、一般財団法人テクニカルコミュニケーター協会が出版している「日本語スタイルガイド(第3版)」を全力でお勧めしておきます。みなさんがいくら買っても私のところには1円も入らないのが悲しいですが、いろいろなTipsが山ほど載っているので、ぜひ読んでみてください。

まとめ

この記事では、わかりやすい文章の書きかたの根底にある「たくさんの文案を書いて、良さそうなほうを選択する」ことが本当に大切で、どのようにして別案を作成するか、という話を事例を挙げて説明しました。

具体的には以下のような話をしてきました。長かったので初めの方は、忘れてしまっているかもしれません。もしよかったら何度でも読み直してみてください。新たな発見があると思います。

  • 主語と述語を明らかにする
  • 文を短くする(ので、し、を敵視する)
  • 文を短くする(箇条書き、表を使って情報を分断する)
  • 語順に気を配る
  • 読み方を工夫しなくてもわかる文章を書く
  • 前提知識が必要な場合は注意する

そして、インターネットにも多くの人が書いてくださっている「わかりやすい文章の書きかた」がありますが、それらと、今回説明した内容は相反しません。ほかの方が説明していることもまた、新しい文案を考える方法論であったり、よりよい文案を選択するときの基準を説明しているものだったりするのです。

この記事を読んだみなさんには、『いろいろなところで説明されている「わかりやすい文章の書きかた」の知恵を使ってたくさんの文案を作り出し、その中から一番いいものを選択すること』が文章を書くときの正しい道である、とわかってもらえると嬉しいです。

文章を書くことが得意な人たちは、このようなことを体得している人だろうと思います。みなさんも、なかなかいい文章が思い浮かばない…と手が止まってしまったら、間違っていてもいいので、いろいろなパターンの文案を書いて、どれが一番いい文か選択することを習慣にしてみてください。わかりやすい文章は、突然生まれるのではありません。多くの文案から選択されるものなのです。

お願い

おつかれさまでした!

もしここまで読んで、「なるほど、自分が文章を書くときに使えるぞ」と思ったり、「ブックマークしておこう」とか「これは同僚に伝えなければ!」と思ってシェアしたりしてくれれば、この文章の目的は達成できました。

この記事が出たら、私は自分のTwitterアカウントから「書いた」みたいなツイートをするつもりです。その後1週間くらいは、毎日エゴサーチをしているでしょう。みなさんは「LINEのテクニカルライターが書いた記事を読んだ!使えそうだった!すごかった!」とか「これはシェアせざるを得ない!」みたいな一言をつけてリツイートしてもらえると嬉しいです。それを読んで私もチームのみんなも「わーい!」と喜びます(オマージュ再び)。よろしくね!

そして、この記事の評判が良かったら第2弾も出すつもりです。第2弾では、「インターネットではほとんどお目にかからないけど、本当にその通りじゃないか!目からうろこ!」と思うこと間違いなしの内容をお届けする予定です。お楽しみに!

Related Post