【読書】技術をつたえるテクニック

技術書典6にて、表紙のデザインが可愛かったのでおもわず買ってしまいました。

私はQiitaLTなどで技術を発信しているのですが、自分でうまく伝えられていないと思うことがあるため、こちらの本を読んで学ぼうと思いました。

書評を書くのは初めてなので、内容や構成などに問題がありましたら、遠慮なくTwitterのリプライやDMなどでご指摘くださると嬉しいです。

感想

大きく3つの章に分かれています。

  • 1章:わかりやすい文章の書き方
  • 2章:わかりやすい発表の仕方
  • 3章:教わり上手になるには

まず「はじめに」を読んで、「著者さんすごい!」となりました。エンジニアという理系の能力があり、わかりやすい文章を書いたり説明したりする文系の能力も兼ね備えている方は本当に尊敬しています。

特に随所に出てくる例えがわかりやす過ぎました。すらすら読めたのは例えのおかげが一番大きかったです。コラムの入れ方も絶妙でした。紹介されているテクニックがどこで使われているか探すのも面白いです。

わかりやすい文章の書き方と発表の仕方は、重複するテクニックも多いです。1章の文章の書き方では重複するテクニックも書き、2章の発表の仕方は発表ならではのテクニックを中心に書いてあると感じました。

私が文章の書き方で気になったことは、「何度も推敲する」ことと「そのときにしかかけない文章を書く」ことはトレードオフではないかということです。推敲すればするほど文章はブラッシュアップされますが、その分時間はかかって「そのときにしかかけない文章」ではなくなる気がします。私が今書いている文章もまだまだいくらでも直せる箇所がありますが、早く見てもらいたいため、公開します。

3章の教わり方で「わからないことを正直に言う」ことは当たり前だと感じましたが、文書化されているのは見たことがなかったので、もっと多くの人に届くと嬉しいです。

このようなつぶやきをしたこともあります。

「人前で話すときに反応がないのが辛い」と書かれていましたが、完全に同意見です。

勉強会でLTをしたときに懇親会であまりフィードバックをもらえず、「やっぱりつまらなかったのかな…」と思ったことがありました。話しかけづらいオーラを発していないつもりだったのですが、悲しかったです。

なのでこの記事を読んだみなさんはぜひ勉強会で発表者の方に声を掛けてください!! 些細なことでも喜びます。LTで発表している人は神様でも何でもないので、気軽に話しかけていい存在です!(少なくとも私は)

著者さんから結城浩さんへのリスペクトがものすごい伝わりました。私は「数学ガール」すら読んだことがないので、読んでみたくなりました。参考にされた結城浩さんの「教えるときの心がけ」というWebサイトはパッと見ただけで素晴らしいと思ったので、時間を作って読みます。

学んだこと

技術書の書き方

  • みんなに最適な説明はない
  • 本文の前に「想定する読者」と「読者のゴール」を明記する
  • 難しい内容は身近な例に置き換える
    例えが作れてこそ理解しているといえる
  • 疑問を抱かせてから説明する
    凍えた時間が長いほど毛布があったかいのと同じ原理
  • 伝えることを一つに絞る
    一度に多くのことは伝わらない
  • できる限り余計な情報を削る
  • 作成日やツールなどのバージョンを明記する
    時代によって事実は変わるため
  • 伝える情報の初源を探す
    他人のブログなどは間違っていることもある
  • サービスなどの名前を間違えない
    読者が混乱し、間違えられた側もいい気持ちがしない
  • 略す場合は最初に正式名称を書く
  • 表記揺れをなくす
    読者が気になると内容が頭に入らなくなる
    「Re:VIEW」などのツールを使うといい
  • 初めて出る言葉は説明する
    読者が知らない言葉を使うと伝わらない
  • 「それ」や「あれ」を使わない
    読者が戻って確認することになる
    再度対象を書くべきだが、書き過ぎても読みづらくなる
  • 複数の解釈ができる文章を書かない
  • 複数ある修飾語は長い方を先に書くとわかりやすい
  • 平坦な文章にはアクセントを付ける
    読者が飽きる
    コラムや会話形式、イラストなどを挿入するのがいい
  • 長い文章は区切る
    50文字を目安に「。」を付ける
    箇条書きにするのもいい
  • 「おそらく」「らしい」などは使わない
    断言できないと読者がその理由を考えて悩む
    どうしても断言できない場合は理由を書く
  • スムーズに読めるようになるまで読み返す
  • 実際の読者層に読んでもらう

発表の仕方

  • 準備には時間がかかるもの
  • リハーサルは絶対に必要
    発表がうまくいかないのはリハーサルが足りていないため
  • いきなり話さない
    聞き手のいる場所とゴールを確認してから話す
    技術書の書き方と一緒
  • 大勢いても1対1で対話するように話す
    「1対多の演説」と思われると聞き手の集中力が切れる
  • 「あー」「えー」より沈黙する方が話し上手にみえる
  • 集中して聞いてほしいところでは動く
    動くと聞き手は目で追うため
  • 話す速度に緩急をつける
  • 聞き手の反応を見ながら話す
    話すことに一生懸命になり過ぎない
  • 聞き手を安心させてから話す
    知らなくても恥でないと示す

教わり方

  • 勉強会では発表者にリアクションする
    「反応がない」=「つまらないと言っている」
  • 伝える側を経験する

おわりに

参考文献・Webサイト

Written by

iOSアプリを開発しています。Swift楽しい✨ Qiita:https://qiita.com/uhooi 趣味:テニス、アナログゲーム

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store