テクニカルライターになるために、参考にした、書籍と資料を紹介します。
2021年よりテクニカルライティングを学んでいます。
最初は何をすべきかが分からずに、本を読み、動画を見て、ひたすら書くというのを続けていました。まだまだ勉強中ではありますが、徐々にコツを理解してきて何とか続けて来れてます。
そんな中で、ライティングに興味を持つ方から「どんな勉強すると良いです？」や、「どんな本がオススメ？」と質問されることが増えてきました。良い機会なので、今まで学習してきた中で、良かった内容をまとめてみようと思います。
これからテクニカルライティング学んでみたい方や、テクニカルライターって何をするのか？という方のお役に立てば嬉しいです。
私はテクニカルライター兼ドキュメントのプロダクトマネージャーという役割で働いているので、純粋なテクニックと併せて、設計や届け方についてのおすすめも紹介しています。
はじめる前に見る・読む / マインドセット編
はじめに、そもそもテクニカルライターとは何をしているのか、どのような知識が必要なのか、そんな全体像を理解する必要があります。
そのため、まずは本を読む前に、ざっくりとテクニカルライターについて理解できるコンテンツをご紹介します。Youtube動画やWebの記事なので全て無料で見られます。先にこちらから見て/読んでみてください。
LINE Technical Writing Meetup
LINEさんが毎月開催しているTechnical Writing Meetupの第１回目の動画です。この動画を見れば、テクニカルライターが何をしているのかが学べます。『テクニカルライターって何？』という質問の答えがここにあります。
ちなみに、このイベントは毎月開催していて、全ての回おすすめですのでお時間ある方は是非ご覧ください。2022年8月時点で15回ほど開催されています。テクニカルライティング業界が盛り上がっているのは、LINEさんのおかげと言っても過言ではない気がします。
テクニカルライティングの基本
サイボウズの仲田さんのスライドです。新入社員向け研修資料を公開していただいていて、これがとても良いです。書き方のBefore -> Afterが具体的に説明されていてとてもわかりやすい。
今はリモートでテキストコミュニケーションが中心かと思いますので、全社員に普及しても良さそうな資料です。
applis テクニカルライティング
LINEでテクニカルライターをやられているZenigamiさんのサイトです。
文章が丁寧で綺麗に整理されているので、本当に読みやすい。まさにテクニカルライターの方が本気出すとこんな綺麗なコンテンツになるぜというお手本のよう。
サイト内に「テクニカルライティング」というカテゴリがあり、開発ドキュメントの書き方や推敲のポイントなどがまとまっています。一通り目を通しておくのがオススメです。
The documentation system
Divioのドキュメントシステムです。
テクニカルライターは、「正しく書く」という業務に加えて「正しく届ける」という業務も必要になります。ドキュメントを必要とする方々に正しく届けるためには、サイトの設計がとても重要になります。
DivioのThe documentation systemでは、「正しいドキュメントシステムの構築方法」として、ドキュメントサイトの設計にスポットを当てています。
ドキュメントサイトに必要なカテゴリとして、「Tutorials」「HOW-TO-GUIDE」「REFERENCE」「EXPLANATION」の4つをあげていて、それぞれ具体的にどう書くべきかを解説しています。
質の高い技術文書を書く方法
文章を書く時に心がけることがしっかりまとまっています。特に「文書から得られるアウトプットをまず定める」と「読み手を常に想像する」のセクションがとても良かったです。読み手を意識することで、書かなくてはいけないドキュメントが見えてくるので。
余談ですが、記事の中に出てくるworking backwardsはアマゾンの最強の働き方に詳しく載っています。面白い本なので、ご興味ある方はこちらもぜひ。
テクニカルライティングをはじめる / 全体把握編
マインドセットができたので、次からは具体的に何を学ぶべきかを理解します。
日本語スタイルガイド
先ほどのLINE Technical Writing Meetup でも紹介されていた日本語スタイルガイド。第３編の「テクニカルライティング技術の要点」を一通り見ておくと、最初に必要なことが網羅されています。
ちなみにこの本は一気に熟読するというよりは、手元に置いておいて、辞書のようにリファレンス的に利用するケースが多いです。
The Product is Docs
テクニカルライターとしてチームでどう動くのが良いか、を丁寧に書かれた書籍。「プロダクトマネージャーと働くには？」「サポートチームと働くには？」など、各ロールとの接し方も書いています。
英語なのでとっつきにくさもあると思いますが、時間をかけて翻訳ツールを使いながらでも読むと良い一冊です。
ロジカル・ライティング―論理的にわかりやすく書くスキル
文章の組み立て方や、表現としてどう書くか、ライティングについて網羅的に書かれた一冊。15年ほど前の本なのですが、現在でも利用できるテクニックが書かれているので、いまだに人気なのが頷けます。
ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング
2023年3月30日に発売されたこちらの本。『ドキュメントをなぜ書かなくてはいけないのか？』『どう書けば良いのか？』など、ドキュメントの作成から運用までを丁寧に解説してくれている本です。
ドキュメントについておすすめの本を１冊だけ紹介してくれ、と言われたらこちらの本を紹介します。
どう書くか / テクニック編
次に学ぶのは、どう書くべきかの具体的なテクニックにフォーカスした書籍です。
数学文章作法 基礎編
「数学」とタイトルに入っていますが、数学に関係する方だけではなく、良い文章を書きたい人のための本です。「なんでうまい文章が書けないのだろう」「自分の思っていることがうまく文章で伝えられない」などの悩みを持っている方にはピッタリな本だと思います。
ちなみに、続編に『数学文章作法 推敲編』があるので併せて読むとより理解が深まります。
迷走しない!英語論文の書き方 秘密は「構造」作りにあり
文章の構成方法について詳しく書かれている一冊。
文章を最初から最後まで、読者が迷わずに読み進めるための構成方法を教えてくれます。
書き方としては、
主張点を明確にする
アウトラインを構築し、主張をサポートする
アウトラインを利用してパラグラフを書いていく
というシンプルな流れがいかに重要か、それぞれを具体的にどう書いていくべきかを教えてくれます。いかに上手な文章でも、組み立て方がいまいちだと読みにくくなってしまいますからね。
できる研究者の論文生産術 どうすれば「たくさん」書けるのか
まず「ドキュメントを書くことは難しい」ということを明らかにして、ではどうすれば書けるようになるか？の方法を紹介してくれる本。
この本は具体的な論文の書き方のHOWTOだけではなく、「執筆のための時間を確保しようぜ」とか「励まし合う仲間作ろうぜ」のような仕組みづくりのやり方も書かれています。
ドキュメントを書くのって、実はテクニックだけじゃなくて環境もとても大切なんだなと気付かせてくれます。
「とはいえ書けないんだよね〜」と思っている方は、第2章の『言い訳は禁物』の章だけでも読んでみてはいかがでしょうか…!?
リーダブルコード
大多数のエンジニアが読んでいるであろうこの本。テクニカルライターも読んでおくべきだと思います。
なぜか。サンプルコードを正しく書くためです。
テクニカルライターの読む文章のほとんどはエンジニアが読むことが予想されます。そのため、ドキュメントに書かれたサンプルコードもエンジニアが読んで違和感なく書かれている必要があります。
熱心に読む必要はないかもしれませんが、ふむふむ、こういうふうに書くのね、とざっと目を通しておくのをオススメします。
何を書くか / 問題を知る編
何を書こうか迷った時に参考になる本を集めました。何を書くかで大事なことは、「課題を見つけること」と「読者目線を持つこと」です。そこら辺が使える方法が書かれた書籍を集めました。
ヒアリングやリサーチの場合、基本的にはリサーチはプロのリサーチャーに任せるのが一番だと思います。
しかしながら、ある程度の技術や知識は知っておいた方がスムーズに進む場合があることと、軽い雑談からユーザの本質を捉える必要も出てくると思うので、ある程度の知識を得ておくことはオススメです。
ユーザーの「心の声」を聴く技術
お客さんの問い合わせ内容をドキュメント化するのはとても良いフローです。ドキュメント化することで、同じ内容で困っている方の助けにもなります。
その際に大事なのは、お客さんの問い合わせ内容をそのままドキュメント化するのではなく、そのお客さんが本当に欲しい内容を理解して、ドキュメント化する必要があります。そのためにはお客さんの声をよく聴く必要があります。
帯にも書いてますが、『「こうしてほしいです」を鵜呑みにするから失敗する』という通りで、本当にして欲しいことは何か、じっくり理解するためにどうするか、を解説してくれる本です。
LISTEN――知性豊かで創造力がある人になれる
「聞くこと」に特化した本です。私自身は人の話を聞くことは得意だと思っていたのですが、この本を読んで「全然聞けてなかったな」と反省しました。ちょっと分厚い本ですが、どの章から読んでも大丈夫なので、興味ある項目をピックアップして読んでいくのが良いです。
イシューからはじめよ
大人気の本なので既に読んでいる方も多いのではないでしょうか。テクニカルライターとしては、利用者を「犬の道」に踏み込ませないようにユーザーの理解を進めることが大事なのだと思います。特にオススメは「メッセージドリブン」の章です。ライティングに活かせる内容が多く含まれています。
どう作るか / 設計編
作成したドキュメントは、利用方法で迷っている人に素早く正しく伝える必要があります。
超明快 Webユーザビリティ ―ユーザーに「考えさせない」デザインの法則
Webサイトの設計について書かれた本ですが、考え方として参考になります。
ポイントは「考えさせない」ということです。欲しい情報がどこにあるのかを考えさせず、メニューを見たらすぐわかる、とか検索ですぐに辿り着ける、ということが大事になります。
実はテクニカルライティングで一番影響を受けたのはこの本かもしれません。
DESIGNING CONNECTED CONTENT
コンテンツファーストでデザインしようと呼びかけている本。
増えすぎるコンテンツをいかに繋げていくか、コンテンツ構造の設計の大切さを書いている一冊。
ドキュメントは無限に増えていくので、無駄に増やすのではなく、必要なものは連携したり、新規作成ではなく更新(追記)したり、運用設計をしっかり考えなくてはと認識させてくれました。
ヘルプサイトの作り方
その名の通りヘルプサイトの作り方が書かれた本。この一冊でヘルプページの役割や作り方が網羅されていてすごい。ヘルプページ作成の担当になったら、先にこの本を読むのが良いと思います。
良いFAQの書き方
FAQの書き方に特化した本。
Qの作り方で60ページ、Aの作り方で100ページという膨大なページ数で、サンプルを交えて解説していてとても分かりやすいです。
どうしたら読みやすくなるか / デザイン編
文章でも見た目を整えるのが大事です。見た目を整えるといっても派手なことをする必要がないです。非デザイナーでも知っておくと便利なデザインテクニック本をご紹介します。
ノンデザイナーズ・デザインブック
こちらも大人気なので、読んでいる方も多いと思いますが改めてご紹介。ノンデザイナーズデザインブックです。「接近」「整列」「反復」「コントラスト」だけでも覚えて実践するだけでも、だいぶ見た目が整うなとびっくりします。
Google流 資料作成術
データの視覚化の考え方や伝え方の本であり、データを使っていかに人を動かすかがテーマの本です。小手先のテクニックというよりは、データを利用してストーリーを伝える重要性を描いた本です。
データをガッツリ利用する必要があるドキュメントを書く場合、本書の書き方や伝え方が参考になります。
伝わる［図・グラフ・表］のデザインテクニック
この本の良いところは、良い例と悪い例のサンプルを比較して説明してくれるところです。悪い例もあるのでダメなところが一目で分かって理解しやすい。
非デザイナーの私は、グラフ作成が難しくてハマってしまい無駄に時間を使ってしまうのですが、基本この本の通りに作れば良いレイアウトになるので、非常に助かっています。
Webアプリケーションアクセシビリティ
ドキュメントもアクセシビリティも、必要な情報を届け、それを最大化させるために必要なものです。考え方としてとても参考になりました。
読みやすいですが理解するのが難しい本ではあるので、第6章でデザインシステムについて触れている章だけでも読んでみると面白いです。（私が単に好きというだけですが）
どう届けるか / 発信・SEO編
完成したドキュメントは、正しい読者に正しく早く届ける必要があります。そんな時に参考になる書籍です。
伝わるWebライティング -スタイルと目的をもって共感をあつめる文章を書く方法
作成したドキュメントの伝え方を紹介しています。
「コミュニティを作ろう」「売り込まずに売るには」という章があり、筆者はコミュニティ構築はライターの仕事の一部という考え方を持っています。良い文章を書き、適切な読者に届けるまでが求められます。より良い届け方を知りたい方はぜひ読んでみてください。
10年つかえるSEOの基本
この本を読んで、SEOとは検索順位を上げるためのテクニックではなく、検索者に対してしっかりと情報を伝えるためのテクニックだということがわかりました。この考え方を最初に学べたのは大きかったです。
アクセス分析すると大半の方はGoogle検索からサイトに辿り着いているので、SEOで適切にドキュメントを届けるのは重要な施策といえます。
Google流 ダイバーシティ&インクルージョン
ダイバーシティはなんとなく聞いたことがあったけど、「インクルージョンとはなんぞや？」という状態でした。インクルージョンとは、誰も排除しない状態を言うようです。
結局何のためにドキュメントを書いているのかというと、サービスの利用者誰一人として置き去りにしないためなのかなと思います。
この本に書かれているチェックリストを全て網羅するにはかなり時間がかかると思いますが、少しずつでも改善していくべきなのだろうなと思います。
考え方として非常に勉強になりました。
まとめ
テクニカルライティングに関するオススメの動画/記事/書籍をまとめました。
気になった本を熟読していただくもよし、１０冊くらいまとめて読むもよし、あなたのリーディングスタイルに合わせて読んでいただけると嬉しいです。
今回は無理やりカテゴリ分けして紹介しましたが、ほんの中で内容重複している箇所はもちろんあるので、いろいろな本に触れていただくとより理解が進むと思います。
そして、ライティングが上達するには、とにかく書くことだと思います。書いていく中で迷ったり悩んだりした際に、このnoteがお役に立てれば幸いです。
最後に、みなさんにお願いです。
私自身もまだまだテクニカルライターとしては勉強中なので、オススメの書籍や記事がありましたらぜひtwitterで教えてください。読みます。
また、今後学んだこともこちらのnoteに随時追記していきますので、よろしくお願いします。
テクニカルライティング楽しいので、一緒に学んでいきましょう!!
■更新履歴
20230501: 下記追加しました。
- ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング
- Webアプリケーションアクセシビリティ
読んでいただきありがとうございます。