【書評】『読み手につたわる文章 テクニカルライティング』を読んでみた

はじめに

こんにちは、CloudBuildersのsugawaraです。

みなさんは資料作成／ドキュメント作成は得意でしょうか？正直、自分はとっても苦手です。資料の見栄えが悪かったり、手順や説明がわかりにくかったり・・・。作成した資料について、レビュー時にボロボロに言われたこともあります。

そこで、最近は資料作成系の書籍を色々と読み漁っているのですが、とても分かりやすい一冊に出会いました！今回は文章作成術についての書籍、『読み手につたわる文章 テクニカルライティング』を紹介します。技術書典で販売していた薄い本なのでサクッと読めて、なおかつとても勉強になりました。

本記事を見て中身が気になった方は電子版のみでOKなら技術書典のサイトから、紙版も欲しいという方はBOOTHにてお買い求めください。

目次

下記は本書の目次となります。

Chapter 01.テクニカルライティングをはじめる前に
1.1 テクニカルライティングとは
1.2 「知らない」と書けない
1.3 まずはいっぱい読んでいっぱい書こう
1.4 完璧主義よりも完成主義

Chapter 02.エンジニアのためのテクニカルライティング
2.1 必要ない人に無駄に文章を読ませない
2.2 文書構造や文章量が適切だと分かりやすい
2.3 書く速度を速くするためにできること
2.4 再利用しやすい文章にする
2.5 技術文書に特有のコツ

Chapter 03. 英語を書いたり翻訳したり
3.1 単語と単語の間にはスペースが1つ必要
3.2 単語や文の単位で翻訳すると失敗する
3.3 前後の文脈やどこで使われるのかを知らずに翻訳はできない
3.4 翻訳はもとの言いたいことに立ち返って考える
3.5 技術文書の翻訳に必須なのは英語力や文章力よりも技術力
3.6 スペルミスが心配ならATOK に頼ろう
3.7 例は「ex.」ではなく「e.g.」

Chapter 04. よいレビューの仕方とされ方
4.1 レビュアー（レビューする側）のコツ
4.2 レビュイー（レビューされる側）のコツ

Chapter 05. どうやってテクニカルライティングを学ぶか
5.1 TC検定3級とは
5.2 Technical Writing Meetupに参加しよう

あとがき

印象に残った点とコメント

今回は第一章で個人的に印象に残った3点に絞って紹介します。

第一章ではテクニカルライティングの定義から始まり、なぜ書くことが難しいのか、書けるようになるにはどうしたらいいのかについて説明されています。

文章術よりも理解

本書でもっとも刺さったのは、“分かりやすい実用文は、文章力のあるなし以前に対象物をよく知らないと書けないのです。”という一文です。自分の中では知っている／わかっているつもりでいても、実はちゃんと知らない／わかっていない。これは文章力ではなく、単に技術力の問題ですね。物事をアウトプットする部分よりも、むしろインプットする部分に問題がある。だから分かりやすい文章が書けない／なかなか書き終わらない。まずはもっと理解を深めるほうに力を入れるべきだと痛感しました。

自分自身、ブログや手順書、設計書などを書いているとき、対象となる技術や詳細がちゃんとわかっていないなと感じることがあります。そのような状態で小手先の文章テクニックな駆使しても、読み手に伝わる効果的な文章にはなりえません。それよりも、まずは書く対象の理解を深めることに重点を置いて取り組みたいと思います。

質より量

次に、実際に文章をうまく書けるようになるコツについてです。筆者が勧めているのは、とにかく“まずはいっぱい読んでいっぱい書こう”ということです。技術書や公式ドキュメント、QiitaやZennなどの個人ブログなどを読み漁り、分かりやすい表現／構成とそうでないものを見極める。良いものはストックしていき、実際に自分が何かを書くときに積極的に使っていくというアプローチです。

実は自分が高校で英語の教員をやっていたときに同じような指導を英文ライティングでしていました。英文ライティングというものは、すべて自分の頭で考えて生み出すのではなく、これまで自分が読んできた／聞いてきた表現などを組み合わせて書くものです。そうしないと、Non-Nativeが書いても文法やコロケーションが不自然になってしまうからです。

母語である日本語でも同じように、過去に読んだ記事の表現や構成などを活用することで、わかりやすくてより自然な文章が書けるようになれる。英語では実践していたのに、第一言語だからと無意識の内に日本語ではやらずに済ませていました。日本語であっても、読んで良かった表現や構成などは意識的にストックして活用していきたいと思います。

とにかく書き切る

最後に、“完璧主義よりも完成主義”になることの重要性についてです。筆者は、とにかく完成させて世に出すことが何よりも大切だと言っています。まだ自信がない、もっと詳しくなったら書こうという心構えでは、一生書けるようにはならないと。

この点について、自分も完全に同意です。自分はこの技術ブログができる前は、アウトプットする習慣がありませんでした。自分用にごく簡単なメモをする程度で、完全に非公開のものです。しかし、実際に何かをブログにまとめることで、自分が理解していない点が浮き彫りになり、その都度調べては理解することを続けました。このプロセスが自分の成長に繋がっていると感じています。

自分のメモや技術のさらなる理解、文章力向上などを目的に、昨年度は少なくとも月1本以上の記事を投稿しました。また、今年度は質は度外視して、とにかく月2本以上の記事を投稿するようにしています。細々とですが、約二年続けている習慣のため、ブログを書くことに対するハードル自体はだいぶ下がりました。完璧主義にならず、とにかく完成させることを意識して、今後もブログを書くということは続けていきたいです。

おわりに

今回は『読み手につたわる文章 テクニカルライティング』を紹介しました。今回は自分に一番響いた第一章からのみポイントをピックアップしてみました。

紹介できなかった第二章以降では、具体的な文章術や英語にまつわる話、レビューのやり方と受け方について扱っています。これらの章に関してもたくさん学びがあるので、是非、ご一読ください！