概要
「技術者のためのテクニカルライティング入門講座」を読みました。 「前提」「読了時間」「感想」「次に関連で勉強すること」「まとめ」を記述します。
前提
目的
主な理由は以下です。
- 普段から技術記事の投稿を習慣化しており、読みやすい書き方を模索していた
- 業務でドキュメントを書く機会が多く、業務向けの書き方も探していた
- ばんくしさんの「tech に薦めている書籍」という記事で紹介されていたので気になった
前提知識
前提知識というほどではないですが、独学でいかのようなことに取り組んでいました。
- 過去に「エンジニアのための文章術再入門講座」という書籍を読んでいた（過去に書いた感想）
- 過去に 50 件以上の記述記事を作成した
読了時間
平均 1 日 30 分で、7 日〜10 日ほどで読み切った印象です。 ただし、ほとんどの章末の問題を飛ばしたので、実践も含めるなら、もっと時間がかかると考えています。
感想
何かしらの機会で技術文書（技術記事、社内ドキュメント、技術書の感想、など）を書く人は、軽くでもいいので読んでおいて欲しい本だと思いました。 そして、全ての内容をその場で理解し実践できるかにかかわらず、印象に残った箇所から取り組めれば、必ず文章に改善が見られると思いました。
理由は、本書における初歩的な部分を説明する第 1 章から第 4 章の説明に非常に共感したからです。 それぞれのタイトルは以下になっています。
- 第 1 章ロジカルライティング × テクニカルライティング活用の基礎知識
- 第 2 章わかりやすく、簡潔な文章を書くテクニック
- 第 3 章読みてに伝わる文章を書くテクニック
- 第 4 章読みやすさを高める文書フォーマット〜表現・表記のルール
どれも、読み手を想定し次の行動に移せる文章を一貫しています。 端的に文章を書くため、そして読み手の負担を下げるために、不要な語尾や文章のつなぎ方を排除したり、情報の構造化を図っています。 これらは大学院生だったときに、論文に用いる端的な文章を普段から意識していたことが、技術文書の内容で言語化されており、非常に参考になりました。 普段、うまく体系化できていなかったり、感情的や話言葉になってしまう部分を改善するために、自分にも他人もお薦めできる内容でした。
実践編である、第 5 章以降も共感できる内容でした。 若干具体的すぎたり、普段あまり使わないテーマ（社外メール、説明書など）だったので、読み飛ばしてしまいました。 第 4 章までの実践編になるので、一読することをお勧めします。
この本を読んでいて反省した点は、レビューしてもらえる機会がほとんどなかったことです。 普段から、ドキュメント化や技術記事の投稿などをおこなうことで他人に読んでもらう文章を意識することで、文章力の向上を図っていました。 それも個人的には練習になりましたが、本当に他人から読んでわかりやすかったのかはわからないと思いました。 業務やプライベートに限らず、レビューをもらえる機会があれば積極的にもらいたいと思えました。
次に関連で勉強すること
技術文書の書き方そのものについて、一定期間に注力して勉強する予定は現場ありません。 長期的な視点からみて、以下に取り組もうと考えています。 特に、「TC 技術検定 3 級テクニカルライティング試験」はキャリアの早いうちに取得したいと考えています。しかし、特に実践はできていません。
- 本書の第 4 章までを繰り返し読む
- 「理科系の作文技術」を読む
- 「TC 技術検定 3 級テクニカルライティング試験」の勉強をする、受験する
まとめ
伝わりやすい技術文書の書き方についてまとめられた良書でした。 1 章から 4 章を、可能な範囲から実践するだけでも劇的な効果が得られると思いました。 個人的にはレビューをもらう機会に乏しいので拡充したいと思いました。 技術文書の書き方は他の書籍や資格もあるので、興味があったら調べてみてください。
