ひびのログ

日々ではないけどログを出力していくブログ

「技術者のためのテクニカルライティング入門講座」内容まとめ&感想

読んだ本

技術者のためのテクニカルライティング入門講座 Kindle版 - Amazon アフィリエイトリンク

以前読んでまとめていたものがあったのでブログに投下。

本の要約

読みやすい文章を書くために

読みづらい文書になる要素

  • 一文が長い
  • 自分視点で書いている
  • ライティング技術が活用できていない

いい文章を書くための 2 つのスキル

  • 論理的に考える「ロジカルシンキング」
    • 自分の考えを効率的・効果的に整理して、相手に説明できる
  • 文書作成に使う「ロジカルライティング」
    • ロジックを見える形にし、漏れやダブりがないように組み上げる

「論理的」とは

筋道が通っていること。 読み手にわかりやすく伝わり、次の行動につながるような文章が良い。

文章にする際は、頭の中にある論理を読み手の論理に組み替えて記述すべき。

文章を書くためのロジカルシンキング

「読み手」を考える

読み手は目先の相手だけではない。 上司に提出したとして、その上司や顧客が見る可能性もある。 対象者を広げて考える意識付けによって、わかりやすさが上がる。

「目的」を考える

読み手が何をすべきか分かるように、目的を明確にする。 この文書は何を目的としているのかを常に考える必要がある。

「ロジック」を考える

書き出す前にロジックを組み立てる。 ロジックツリーなどを利用して、情報を整理して組み立てる。

テクニカルライティング技術

わかりやすく、簡潔な文章を書くテクニック

  • 一文一義にする
    • 文を繋がない
  • 一文は 50 字以内にする
  • 5 W 2 H を入れる
    • 「読み手は知っているはず」は NG
  • 文書のタイトルで目的を伝える
  • 書き言葉を使用する
  • 接続詞は最小限かつ効果的に使用する
    • 注目させたいときだけ使えば事足りる
  • 時間をおいて見直す

読み手に伝わる文章を書くテクニック

  • 重要な内容を最初に書く
  • 状況説明ではなく、行動を書く
    • ☓「〜のためには〜が必要です」
    • ☓「〜をしたら〜になる」
    • ◯「〜をしてください。〜が可能になります」
  • 否定表現は理解できる範囲で
    • 二重否定は NG
    • ☓「〜しないとは限らない」
  • 読み手がすべきことは能動態、結果は受動態
    • ☓「〜させる」
    • ☓「〜となります」
  • 具体的に情報を盛り込む
    • 5 W 2 H
  • 「など」は適切に使う
    • なくてもいいなら使わない
      • 今後の取り組みや目標には使わない
    • 何を示しているのか明確にする
      • 「〜などの『◯◯』を使用してください」
  • レビューしてもらう

表現・表記のルール

  • 要素ごとにブロック化する
  • カッコは 2 種類を基本とする
    • 言い換えや製品名には ()
    • 固有名詞や強調には 「」
  • 階層構造は 3 階層まで
  • 箇条書きは 7 項目まで
  • 箇条書きには見出しをつける
  • 表記を統一する
    • 英語・カタカナ
    • 略語
    • 長音符

ここには書かないが、以降は実際に文書を作成するときの流れが載っている。

感想

  • いろいろなサイトや本を見ていたので知っていたものもあったが、初めて聞くこともいくつかあった
  • 著者が取扱説明書を書いている人なので、紙の文書向け・消費者が見る文書向けの話がちょいちょい入ってきていた
  • 自分の思考を整理するときや、口頭で話すときに使えるテクニックもある
  • もちろん、自分は知っているが本では網羅されていないこともあった
    • MECE とか日本語のルールとか
    • それらも組み合わせて最強の文書作成術を身につけるんだ