ガナリヤの付録

学会や参加記のみをまとめています (それ以外は他サイトです)

LINE Technical Writing Meetup vol.1 まとめ

LINE Technical Writing Meetup vol.1

これだけ気を付けて書いてもらえるとみんな幸せになるポイント2つだけ

この講演では,文章をキレイにするための2つのポイントのみに絞って説明します.

主語や目的語を明確にしよう

用語がなにを指しているのかを明確にしよう. 読んでいる読者がその単語を理解できない可能性がある.また,より適した単語がある可能性がある.

伝えたいことをあらかじめ言って相手に伝えておく. 書き手が相手にあわせて移動することはできないため,相手を移動させる.

概要を書くことによって以下の効果がある

  • 必要な情報があるか読者が理解できる
  • いらない情報を取らない という選択ができる(確かに)

タイトルは読者に何を伝えるかを1行で伝える. しかし,それだけではすべては伝わらないため,概要で補って読者に正しい判断をしてもらう.

分かりやすいドキュメントを書く「テクニカルライター」という仕事