いちばんやさしいテクニカルライティング入門
こんにちは、銭神です。この入門は、読む人にわかりやすく伝える技術「テクニカルライティング」について、はじめてでもやさしく学べるように公開しています。よかったらご覧ください。
・・・
文章を書いているときに、どう書けばいいかわからないときはないでしょうか？あるいは他の人が書いた文章を読んでいるときに、「わかりづらい」と思うときがあるかもしれません。
わかりやすい文章を書くには、「テクニカルライティング」というスキルが重要になります。このテクニカルライティング入門では、テクニカルライティングの基本から応用までを学ぶことができます。
文章の書き方がよくわからない方でも学べるように、わかりやすく説明しています。仕事はもちろん、プライベートでも役に立つ、わかりやすい文章を書くスキルを、誰でも身につけることができます。
私はLINEヤフー株式会社でテクニカルライターとして働いています。それまではプロダクトマネージャーやエンジニアとして、ソフトウェアの開発に携わっていました。この経験をもとに、この入門を書いています。
テクニカルライティングのスキルを身につけて、わかりやすい文章を書けるようになりたい方は、ぜひこの入門で一緒に学んでいきましょう。文章を通したコミュニケーションが、もっとたのしくなると思います。
この入門の学びかた
この入門はnoteでもお読みいただけますが、電子書籍版もあります。いちど購入いただければ、入門が更新されたとき、電子書籍も無料で更新できます。有料記事が追加されたときも、電子書籍版は追加料金をいただきません。よかったらご覧ください。
・・・
第1章 テクニカルライティングの概要
はじめに、そもそもテクニカルライティングはなにか？ということについて、歴史や必要性などをもとに学びます。また、テクニカルライティングを主な仕事とする「テクニカルライター」という役割についても見てみます。
1.1 テクニカルライティングとはなにか
まず、「テクニカルライティング」ということばの定義について、具体例をもとに整理します。
1.2 テクニカルライティングの歴史
テクニカルライティングはいつ生まれて、どのように発展してきたのか。また、これからどうなっていくのか？ということを見てみます。
1.3 テクニカルライティングの必要性
そもそも、なぜテクニカルライティングがあるのでしょうか。テクニカルライティングの必要性について、理由をもとに見てみます。
1.4 テクニカルライターとはどういう人か
テクニカルライターという職業について知っておくと、テクニカルライティングを学ぶ上で役に立ちます。ここでは、その業務内容などを見てみます。
1.5 とあるテクニカルライターの一日
テクニカルライターがどのように仕事をしているか、いまいち想像できないかもしれません。ここでは、具体的な例を見てみます。
1.6 テクニカルライターに必要なスキル
テクニカルライターには、コミュニケーション力など、文章を書く以外にもいくつかのスキルが必要になります。このスキルについて見てみます。
第2章 テクニカルライティングの基本
次に、テクニカルライティングの基本として、わかりやすい文章を構成する要素と、わかりやすい文章を書く手順について説明します。内容は少ないですが、とても重要なことなので、しっかりと学んでみてください。
2.1 わかりやすい文章を構成する3つの要素
文章はわかりやすく書くことが大切ですが、では「わかりやすい」とはどういうものをいうのでしょうか。ここでは、「わかりやすい」を構成する要素について学びます。
2.2 わかりやすい文章を書くための5つのステップ
実際に文章を書く前に、やるべき手順があります。また、書いた後にもいくつかの手順をふむことで、わかりやすい文章になります。この手順について学びます。
第3章 テクニカルライティングにおける文章術
それでは、いよいよ具体的な文章術について学びましょう。この章で学ぶことさえ実践すれば、誰でもわかりやすい文章が書けるようになります。ページはたくさんありますが、ひとつひとつの内容は少ないので、安心して読み進めてください。
3.1 結論からはじめる
はじめに要点を伝えることは、文章のもっとも基本的な原則です。これについて、例をもとに学びます。
3.2 PREP法を用いる
文章の型を知っておくと、わかりやすい文章がスムーズに書けるようになります。ここでは、代表的な型であるPREP法について学びます。
3.3 文は50文字、段落は150文字を目安にする
わかりやすい文章を書くとき、文や段落の文字数には目安があります。この数字について、根拠をもとに学びます。
3.4 読者がわかることばを用いる
難しいことばがあると、読むのに時間がかかったり、読むのを途中でやめてしまうかもしれません。ここでは、わかりやすいことばついて学びます。
3.5 読者の視点で書く
能動態と受動態など、文章の中でことばを選ぶときには、読者の視点にすることが大切です。これについて学びます。
3.6 見出しや箇条書き、表を用いる
文章以外に文字で伝える方法として、見出しや箇条書き、表があります。これらの使いどころなどを学びます。
3.7 図を用いる
文章を書いているとき、文字だけだと説明しづらいことがあります。このようなときに役立つ、イラストなどの図について学びます。
3.8 主語を明確にする
日本語では主語を省略しても文として成り立ちますが、わかりづらくなることがあります。これについて、主語と明確にすることの大切さを学びます。
3.9 主語と述語を近づける
主語と述語が離れていると、述語に対する主語がわからなくなることがあります。このふたつを近づけることの大切さについて学びます。
3.10 主語と述語を対応させる
文章を書いているとき、意識しないと、主語と述語がいつの間にか変わっているかもしれません。こうならないための方法を学びます。
3.11 修飾語と被修飾語を近づける
被修飾語になりえることばがいくつかあるとき、修飾したいことばと修飾語を近づけないと、読む人はどちらを修飾しようとしているのかわからなくなります。このことについて学びます。
3.12 複数の修飾語は文字数が長いものから書く
例えば「二階建ての赤い図書館」のように、修飾語がいくつかあるときに、どのような順番で書けばいいかを学びます。
3.13 「場合」と「とき」を使い分ける
時間的な条件や状況を表す「場合」と「とき」ということばについて、その使い分けかたを学びます。
3.14 「より」と「から」を使い分ける
比較や起点を示すことばとして「より」と「から」があります。このふたつの使い分けについて学びます。
3.15 「に」と「へ」を使い分ける
移動に関することばとして「に」と「へ」があります。このふたつの使い分けについて学びます。
3.16 読点をうつ
同じ文でも、読点の位置が適切かどうかで、わかりやすさが大きく変わってきます。ここでは、読点のうちかたについて学びます。
3.17 表記ゆれを統一する
「ユーザー」と「ユーザ」のように表記がゆれていると、文章がわかりづらくなります。ここでは、このようなゆれを統一することについて学びます。
第4章 テクニカルライティングの実践
文章術をひと通り学んだら、次は実践を通して身につけましょう。ここでは確認テストと練習問題により、文章術を身につけます。また、仕事やプライベートでも役に立つチートシートも掲載しています。
4.1 テクニカルライティングの確認テスト
第3章で学んだ文章術の理解度を確認するテストを作成しました。知識として身につけるのにも役に立ちます。
4.2 テクニカルライティングの練習問題
テクニカルライティングを身につけるには、学んだ文章術をふまえて、文章をたくさん書くことが大切です。ここでは実践的な問題と解答例を掲載しています。
4.3 テクニカルライティングのチートシート
文章術は、学んだだけでは身につきづらいです。文章を書くときに確認できるチートシートを作成しましたので、ご利用ください。
第5章 テクニカルライティングの発展
文章のレビューや英文の作成など、より発展的なテクニカルライティングについて学びます。また、生成AIをテクニカルライティングに活用する方法も紹介します。
5.1 文章のレビューを受ける
文章は、他の人に見てもらうことで、よりわかりやすい文章にすることができます。ここでは文章に対するレビューについて学びます。
5.2 テクニカルライティングに役立つツール
文章を書くときは、どのようなものを用いるのでしょうか。ここでは、テクニカルライティングに役立つツールを紹介します。
5.3 日本語をもとに英語の文章を作成する方法
文章は、日本語だけではなく、英語でも書く機会があるかもしれません。ここでは、日本語をもとに英文を書く方法について学びます。
5.4 生成AIをテクニカルライティングに活用する方法
活用が進んでいる生成AIは、もちろんテクニカルライティングにも大きく役立ちます。ここでは、生成AIを活用する方法について学びます。
第6章 テクニカルライティングとこれから
この入門の最後に、テクニカルライティングの学び方や身につけ方、あるいはテクニカルライターとしてのキャリアパスなど、これからのことについて学びます。
6.1 テクニカルライティングの練習をする方法
この入門を終えた後で、テクニカルライティングのスキルを高めていくための方法について学びます。
6.2 3級 テクニカルライティング試験とはなにか
テクニカルライティングの能力を調べる検定試験があります。この試験の概要や対象者について見てみます。
6.3 テクニカルライターのキャリアパス
テクニカルライティングを主な仕事とするテクニカルライターについて、そのキャリアを見てみます。
おわりに
この度は、テクニカルライティング入門をお読みいただき、ありがとうございます。この入門が、テクニカルライティングの基本を学び、実践的なスキルを身につけるお役に立てればうれしいです。
テクニカルライティングに関する情報や、質問については、ぜひ私のXアカウント（@zenizh）をフォローしてください。フォローいただくことで、テクニカルライティングのスキルをより深めることができます。
また、もしこの入門がお役に立ちましたら、ぜひまわりの方にもご紹介いただければうれしいです。SNSでのシェアも大歓迎です。
改めまして、テクニカルライティング入門をお読みいただきありがとうございました。これからもどうぞよろしくお願いいたします。
いいなと思ったら応援しよう！
