先日、社内でテクニカルライティングに関しての勉強会が開催されました。
リブセンス社内の多数のエンジニアが参加し、大盛況となりました。この記事ではそんな勉強会の模様を紹介します。
概要
今回の勉強会では、外部より仲田 尚央さん(@naoh_nak)に講師をお願いしました。テクニカルライティングの分野で多方面で活躍されている方です。「ヘルプサイトの作り方」という本の著者であり、「テクニカルライティング ✕ UX」をテーマにした勉強会の主催もされています。
https://www.amazon.co.jp/dp/4297104040www.amazon.co.jp
テクニカルライティングについて、3時間にわたって濃密に講義していただき、参加した社内エンジニアの満足度も高いイベントとなりました。
開催の経緯
テクニカルライティングの勉強会を企画したのには、大きく2つの理由がありました。
- エンジニアブログの記事を自信を持って書いてもらえるようになってほしい
- 良い文章とはどんな文章かの共通認識を作りしたい
エンジニアブログの記事を自信を持って書いてもらえるようになってほしい
普段外部向けに記事をあまり書かない人にも、自信を持ってエンジニアブログの記事を書いてもらえるようになってほしいという思いがありました。特に今の時期は、12月のアドベントカレンダーを控えています。エンジニアブログの運営側として、ブログへのポジティブな雰囲気を醸成したい思惑もありました。
記事を書いたことを成功体験にしてもらい、さらなる外部発信につながればという思いです。
良い文章とはどんな文章かの共通認識を作りしたい
エンジニアブログの記事をレビューする際に、人によって基準がまちまちになってしまうことがありました。文章全体の構成に関わる問題から、個々の文章の読点の打ち方まで、レビュワーへの依存度が高い状態となっていました。
エンジニアが多く参加したイベントで良い文章について考えることで、良い文章についてある程度の共通認識が持てる状態になることを狙っていました。
講義の内容
実際の講義の中では、弊社の実際の記事を題材に、技術をわかりやすく伝えるための方法を以下のような流れで学んでいきました。
- テクニカルライティングの基本的な考え方を知る
- 伝える情報を整理する
- アウトラインを作る
- トピック単位で文章構成の骨組みを作る
- わかりやすく、簡潔な文章で書く
- 質疑応答
テクニカルライティングの基本的な考え方を知る
まずは、テクニカルライティングの基本的な考え方から教えてもらいました。
以下は、弊社の記事の見出しに対して、テクニカルライティングを適用した例です。
右の方が見出しから趣旨が読み取りやすくなり、断然わかりやすくなっています！
このように、テクニカルライティングの考え方を適用し、読者の立場になったアウトラインにすることで、読み手に効率よく、正しい情報を伝えられるようになります。
テクニカルライティングは、以下のような流れで進めます。
以降の講義は、それぞれのステップに焦点を当てて順番に講義していただきました。
伝える情報を整理する
伝える情報を整理するため、テーマを階層構造に整理していく方法です。
概要から具体へ、全体から部分へと言う整理の鉄則に合わせ、どのように情報を整理していくかを学びました。
どのように情報を分解して整理するかを判断するには、まず読者の目的を考えることが重要だと強調されていました。
講義は、以下のような実践的な演習問題を交えながら進んでいきました。
アウトラインを作る
整理した情報を、文章構成のアウトラインに落とし込んでいく方法についてです。
先に概要や全体像を伝えたあとで、そこで述べた順番のままに詳しい説明をすることなど、良い文章展開について学びました。
その後、弊社ブログ記事の内容を例に、情報を書き出し、情報を整理し、見出しをつけるという一連の流れのなかで、アウトラインが出来上がっていく様子を実演していただきました。
トピック単位で文章構成の骨組みを作る
アウトラインで決まった大まかな流れをもとに、個々のトピックを意識して文章構成の骨組みを作る方法についてです。
トピックを意識することで、読み手にも書き手にも良い影響があります。
わかりやすく、簡潔な文章で書く
細かい文章の書き方についても講義していただきました。
一文を短くする。読点を適切に打つ。こういったことを一つ一つ意識することで読者にとってわかりやすい文章に近づきます。
確認に使いやすいチェックシートも共有していただきました。
こちらの演習問題は、皆さんも考えてみてください。
質疑応答
質疑応答の中では、テクニカルライティングの考え方を学ぶ上で役立つ書籍についての質問が出ました。
以下の4冊の書籍を紹介されていました。
- https://www.amazon.co.jp/dp/4866671483
- https://www.amazon.co.jp/dp/4902820102
- 理科系の作文技術 (中公新書 624)
- 入門テクニカルライティング
最後に
仲田さんの尽力のおかげで、内容が濃密で学びの多い勉強会となりました。
テクニカルライティング講座を企画したのには2つの理由がありました。
- エンジニアブログの記事を自信を持って書いてもらえるようになってほしい。
- 良い文章とはどんな文章かの共通認識を作りたい
いずれも、事前に想像していたよりもずっと効果があったのではないかと思っています。
これから先、記事を書くときに意識したり、レビューの中で議論を深めていくことで、エンジニア組織全体としてテクニカルライティングへの理解が深まっていくと良いなと思っています。
