技術書展16で出版された『読み手につたわる文章 – テクニカルライティング』を読んだので、感想やアクションプランをまとめます。

記事の信頼性

• ぼくは独学で未経験から従業員300名以上の自社開発企業へ転職しました。
• 実務ではVue.jsとRailsを毎日書いています。
• 初心者や駆け出しエンジニアがつまづくポイントも身をもってよく理解しています。

読み始めた動機

このブログの執筆に生かしたいなと思い、購入しました。

また、最近は更新頻度が滞ってしまっているため、力を入れ直すきっかけがほしくて手に取りました。

読んだ感想

以下に当てはまる方はぜひ読んだ方が良いと思いました。

1. ブログに力を入れている
2. 社内でドキュメントを残す文化がある
3. テキストコミュニケーションの質を向上させたい
4. わかっているつもりの技術なのにうまく言語化できない
5. テキストにまとめてアウトプットするのが好き

ぼくは1が目的だったため、ブログ執筆に役立ちそうな内容が目に止まりました。

ですがブログ以外にもGitHubのPR上でのレビューのやり取りや、仕様をまとめたドキュメントを書く時など、エンジニアがテキストを使うあらゆる場面に役立つ内容でした。

Slackなどでの日々のテキストコミュニケーションの改善にもつながりそうです。

印象に残った話とアクションプラン

印象に残った話と、その話をもとに設定したアクションプランをまとめます。

完璧主義よりも完成主義

せっかく色々書いたとしても、中途半端な書きかけがブログの下書きにいっぱい溜まっていたり、思いついた構想ばかりがメモ書きとして積まれていたり、という結局誰にも読んでもらえない状態ではうまくなりません。

読み手につたわる文章 – テクニカルライティング p19

先に〆切を設定することが重要です。〆切もないのに何かを完成させられるほど我々の精神は成熟していません。あそこもここもおかしいし、本当は直したいし、もっとこういうことにも触れたかった、最初の構想と違って何もかも全然足りてないんだけど……一旦これを完成とする！ と開き直るためには、自分では動かせない〆切が必要なのです。

読み手につたわる文章 – テクニカルライティング p19

アクションプラン

• ブログの下書き（現在17件）を全て公開し、半年以内に下書きをゼロにする

必要ない人に無駄に文章を読ませない

一通り読んだ後で、ようやく自分には関係のない話だと気付いたときの「関係ないなら早くそう言ってよ！」という徒労感には誰しも覚えがあるはずです。このまま読み進むべきか、自分には関係ないので読まなくていいのかを判断できる情報を早い段階で提示するようにしましょう。

読み手につたわる文章 – テクニカルライティング p23

関係ない人を早めに振い落として残念なミスマッチを防ぐ簡単な方法は、本文の前に「想定する読者層」と「ゴール」を書いておくことです。

読み手につたわる文章 – テクニカルライティング p24

最初に「想定する読者層」および「マッチしない読者層」、そして「ゴール」を書いておくことで、不幸なミスマッチをできるだけ防ぎましょう。これらを書いておくと、著者自身が方向性を見失いかけたときに「これって誰に向けた文章なんだっけ？」「読み終わったらどうなってて欲しいんだっけ？」と振り返る拠り所にもなります。

読み手につたわる文章 – テクニカルライティング p25

アクションプラン

• 今後はブログ記事の冒頭で「想定する読者層」と「この記事のゴール」を記載する

文書構造や文章量が適切だと分かりやすい

一文の長さは、一口で食べられるくらいの量（短さ）にしてください。具体的に言うと、以下のような接続詞が出てきたらそこを「です」や「ます」にして、文章を切りましょう。

• ～ですが
• ～ので
• ～し
• ～して
• ～ため

読み手につたわる文章 – テクニカルライティング p27

アクションプラン

• 記事の執筆が完了したら、「↑の接続詞を使っている箇所がないか？」の観点で見直しする

例示用の IP アドレスやドメイン名を使おう

実はインターネットでは「例示やテストで使っていい IP アドレスやドメイン名」というものが定められています。
例として記載する URL、メールアドレスなどでは次のものをつかいましょう。

• 例示として使える IP アドレス
  – 192.0.2.0/24（192.0.2.0～192.0.2.255）
  – 198.51.100.0/24（198.51.100.0～198.51.100.255）
  – 203.0.113.0/24（203.0.113.0～203.0.113.255）
• 例示として使えるドメイン名
  – example.com
  – example.net
  – example.co.jp
  – example.jp

読み手につたわる文章 – テクニカルライティング p37

アクションプラン

• 「例示やテストで使っていい IP アドレスやドメイン名」の存在を知らなかったので、今後はこれを使う

おわりに

この本での学びを生かして自分のアウトプットの質を高めていきたいと思います。

>>『読み手につたわる文章 – テクニカルライティング』を見てみる

技術書が好きなエンジニア向け

あわせて読みたい

「技術書の内容が頭に入らない」を防ぐ5つの読書方法 「技術書の内容が頭に入らない」を防ぐための5つの読書方法を紹介します。最後まで読めば効率よくインプットできるようになります。