短期間で上達できるテクニカルライティング

コツを知れば短期間で上達します

その5:タイトルを軽視していませんか?タイトルは情報を探す鍵!

自分が読みたい情報が、どこにあるか探すとき、目次を見ます。
タイトル名の付け方の3つのポイントを紹介します。

どんな情報が書かれているかわかること

  • 点検1
  • 点検2
  • 点検3
    これでは、何の点検かわかりません。

  • 主電源を投入する前に点検すること
  • 主電源を投入してから点検すること
  • 操作電源を投入してから点検すること
    これであれば何の点検かがわかります。

読者が知っている言葉を使うこと

コンパイル、リダイレクト、インターラプト、リワインド、、、、
知らない人には、何のことかわかりません。

読者は、自分の頭にあるキーワードと製品の機能名称で探します
注意すべきは、読者が知っている言葉(既有知識)です。

f:id:openup21:20220316151743j:plain

それはマニュアルの種類によっても変わります。

インストラクションマニュアル

入門マニュアル、チュートリアルマニュアル、と言われるマニュアルです。
知識のない方や知識の少ない方など初心者が対象です。
インストラクションマニュアルでは、専門用語は使わないでください。

  • 運転を始めるときは
  • 運転モードを変えるときは
  • 風向きを変えるときは
  • 温度設定を変更するときは
  • タイマーを使うときは

読者の頭にあるキーワードと製品の機能を組み合わてタイトル名にします

リファレンスマニュアル

機能別マニュアル、目的別マニュアル、と言われるマニュアルです。
個々の機能や作業内容を掘り下げて説明します。
すでにある程度の知識を持っている方が対象です。
リファレンスマニュアルでは、専門用語を使っても構いません。

  • コンパイル機能
  • リダイレクト機能
  • インターラプト機能
  • リワインド機能

f:id:openup21:20220318200839j:plain

誰が読むのかを意識すること

パソコンのマニュアルは、分冊するなどして上手く対応しています。
スタートガイドでは、読者が初心者であることを意識しています。
(上級者には必要ない情報です)

f:id:openup21:20220219152923j:plain

スタートガイドでは、次のようなタイトル名になっています。

  • このパソコンをお使いになる前に
  • パソコンの使用環境についての注意
  • パソコンの取り扱いについての注意
  • 各部の名称について
  • セットアップする
  • セットアップの流れを確認する
  • パソコンの準備をする
  • Windows のセットアップをする
  • インターネットに接続する
  • 有線 LAN でインターネットに接続する
  • 無線 LAN でインターネットに接続する
枕文を認知心理学から見直す

認知心理学には、メンタルモデルと用語があります。
人は何かしらの情報に接したときに、
まずイメージを描き、
自分なりの理解を持ちます。
タイトルの後に、書かれる枕文、
この項目では、何が書かれているかを説明します。
読者は、「あ~こんな内容なんだ」、理解してから読むことができます。
何が書いてあるのか?と思いながら読むのとでは、大きな差が生まれます。

マニュアルがこんな風に思われると、大きなマイナスです

犬が近寄ってきたとき、
犬にかまれた経験があると、恐怖感を持ち、逃げ出します。
自分でも犬を飼ってと、親しみを感じていると、近寄ります。
トラブル発生時も同じです。
マニュアルを読んでも役に立たなかった経験があると、
マニュアルを読まずにサービスコールします。

f:id:openup21:20220310105626j:plain(すぐに電話)

マニュアルを読んで対応できた経験があると、まずマニュアルを読みます。