見出し画像

テクニカルライティングのすすめ

📝 PICK UP!

職種に関わらずフルリモート実施中、詳しくは下の『採用情報』からチェック✅

はじめに

こんにちは!Fantiaマーケターの3号です。
noteの執筆を始めて早半年…思うことはひとつ。そう!
「文章が上手くなりたい!!!」

noteだけではありません。
虎の穴ラボで使用しているコミュニケーションツール、Slackを使っていても、ちゃんと相手に自分の意図が伝わっているか…を悩む日々。

虎の穴ラボはフルリモートなので、文章によるコミュニケーションは重要性が高いです。(もちろん適宜WEB会議を行いますが)

伝わる文章って何かな〜と調べていたところ見つけた、テクニカルライティングについてご紹介したいと思います。


テクニカルライティングとは?

辞書に載っていませんでした。
よって定義が曖昧ですが、簡潔なものを以下に引用します。

テクニカルライティングは
読者や目的に合わせて技術をわかりやすく伝える手法です

テクニカルライティングの基本 2023年版

ロジカルライティングは、文字通り論理的な文章を書くための技術です。論理的な文章とは、筋道がきちんと通っていて、読んだ人が短時間で目的を達成できるような文章です。(中略)
テクニカルライティングは、技術的な内容を目的や読み手に合わせて分かりやすく伝える手法です。広義のテクニカルライティングは、ロジカルライティングを含むこともあります。

生産性が向上し 読み手にしっかり伝わる テクニカルライティング入門講座

テクニカルライティングは「技術をわかりやすく伝える」手法のことを指します。
主な対象は技術分野ですが、実務的、実用的な文章に使う技法と考えてよいでしょう。

テクニカルライティングのメリット

  • 読みやすい文章は読み手の時間を節約できる

  • 文章の書き方を学ぶことで、書き手の時間も節約できる

効率的に情報が伝達できるというのがメリットです。

テクニカルライティングの技法

一部になりますがご紹介します!

読み手を想定する

これから書く文章を読む人は、どんな人でしょうか?

まっさらの初心者が読むと想定されるなら、前提を丁寧に説明する必要があります。ベテランに対してなら不要でしょう。読み手ごとに求める情報が異なる場合もあります。個人であることも、不特定多数もあるでしょう。

誰に伝えたいかを明確にすることが必要です。

文章の目的を明確にする

なんのために文章を書くのでしょうか?その文章は、何を伝えたいのでしょうか?

長い文章であればあるほど、論点は外れやすくなるものです。
よく言われるように「結論は先に書く」を意識するのもよいかもしれません。

文章を構造化させる

何かについて調べているとき、今まで読んでいた文章の9割が不要で、知りたかったことがページの一番最後に書かれていたことはありませんか?

読み手や文章の目的にもよりますが、書く情報は整理されるべきです。教科書のように段階的に構造化され、目次があるのが理想でしょう。

一意に伝える

解釈によって捉え方が変わらないようにしましょう。
以下の文章はよくあるNG例です。

牛乳を買ってきて。卵が売っていたら12個買ってきて


読み方によっては牛乳を12個買うことになる

一意に伝えるコツとしては、以下が挙げられます

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

  • 具体的に書く

  • 文を短くする

    • 接続詞を減らす

    • 表や箇条書きを活用する

    • 「という」「こと」を減らす

    • 一文につき一意にする

  • 修飾される側、する側を近づける

  • 二重否定を使わない

読みにくい文章というのとは長かったりする文章のことを言うのではと考えており、読点がたくさんあるのもないのも嫌だな〜とか思ったりするのですが、逆に考えれば読ませたくない文章というはこんな感じでダラダラ書けばいいのではって感じもするのですが、実用的ではないし第一書いていて全然何を言っているのか言いたいのかがわかんなくなっちゃうこともありますし、書いている側からすれば読めばわかるので個人的には一意に伝えるのが一番難しいんじゃないって感じです。

肯定的に書く

一部の場合を除いて、肯定的に書きましょう。
読み手のストレスが減り、好印象を与えられます。二重否定も防げます。
読んでもらうための工夫が必要です。

一部の場合というのは、禁止事項を書く場合です。
以下に例を挙げます。

この場所は関係者だけが入ってよいです。

「関係者以外立ち入り禁止」と書いたほうがよいです。
文章は一部しか読まれないからです。

「〇〇することは禁止されています」と書いていると、とくに緊急時において、文章の前方だけを読んで理解されるものです。

テクニカルライティングで生産性アップ

抜粋になりますが、テクニカルライティングについてのご紹介でした。
文章の書き方を学んで、ぜひ実務に活かしてください!

テクニカルライティングを学びたい人向けの参考

テクニカルライティングの基本2023年版

​​生産性が向上し 読み手にしっかり伝わる テクニカルライティング入門講座

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

​​Technical Writing Courses

感想

いやむっっっず…!難しい。難しくないですか?
できるかも!と思える内容がほとんどですが、実行するのは骨が折れそうです。書いている当人は、内容を頭の中で補完してしまいますからね…。

またお察しのとおり、このnoteはテクニカルライティングの技法を中途半端にしか使っていません!
技法の紹介部分では意識していますが、ここらへんとかもうぐだぐだです。

今回ご紹介したテクニカルライティングは、あくまで実用的な内容を対象にしています。
文学的、娯楽的な文章は対象外。つまりこのnoteもテクニカルライティング対象外です!サボってないです。

文学的な文章(個人的宣伝)

娯楽的な文章(個人的宣伝)

同じ日本語でも文章の技法がたくさんあって面白いなーと思いました。
目的によって技法も変えないといけないですね。

採用情報

とらラボは現在積極的に採用活動を行っております。カジュアル面談やオンライン説明会、エンジニア向けイベントも積極的に開催中です。
少しでも興味をもった方はぜひ採用情報をご覧ください!