Masassiah Blog

現役サラリーマンのスキルアップのための読書まとめ

技術者のためのテクニカルライティング入門講座

『技術者のためのテクニカルライティング入門講座』(高橋 慈子,翔泳社,2018年11月19日)を読了。

読み手はどのような人で,どのような行動をして欲しいのかを明確にして文章を書くこと。これは「伝わる」文章を書くための最も大切なポイントです。(位置 No. 206)

読み手を意識して,どのような行動をして欲しいのかを明確にして文章を書く。

技術者の書く文章がわかりにくい 3 つの理由(位置 No. 223)

  1. 一文が長く,情報量が多い
  2. 読み手を意識せず,自分視点で書いている
  3. 基本的なライティング技術を活用していない

わかりにくい文章と言われないようにしたい。

  • 論理的でない文章=目的まで迷いながら進まなくてはならない
  • 論理的な文章=目的まで迷わず進め,筋道が通っている(位置 No. 263)

論理的な文章を書くため,あらかじめ筋道を通しておこう。

文を書くときに,「伝えたいことが多く,長くなってしまう」という人は,一文一義の文をいきなり書くのではなく,あらかじめ伝えたいキーワードを書き出しておきましょう。(位置 No. 529)

伝えたいことは何か,キーワードを書き出しておく。それにより,冗長な文章になることを防ぐ。

ユーザーマニュアルを作成するときは,機能仕様書を整理するのではなく,ユーザー視点で再構成することが重要です。なぜなら,機能仕様書とユーザーマニュアルは,読み手と目的が全く異なるからです。(位置 No. 1379)

機能仕様書とユーザーマニュアルは,全く別のものということを認識する。