Shoeisha Technology Media

CodeZine(コードジン)

特集ページ一覧

「大雑把な分割から始めよう!」~ソフトウェア開発者に贈るテクニカルライティングの極意

テクニカルライティング作法・外伝 第8回

  • ブックマーク
  • LINEで送る
  • このエントリーをはてなブックマークに追加
2019/09/20 14:00

 テクニカルライティングに役立つ(かもしれない)話をあれこれと書く連載。第8話は、多くのものを列挙するときは大雑把な分割から始めようという話です。

目次

はじめに

 テクニカルライティングでは、なんらかの技術を解説することが多いものです。そのとき、いっぺんに全てを説明しようとしてしまうと、一度に大量の情報を受け取った読み手は消化不良をおこしてしまいます。最初は想定している読者にすっと受け取ってもらえるサイズの情報量から始めて、それからだんだんと情報を増やしていくような書き方をするとよいです。

 前回は「簡単な話から初めてステップアップしていく」というやり方を話しました。今回は、多くのものを列挙するときに、大雑把な分割から初めてだんだん細かい要素へとドリルダウンしていくパターンを紹介します。

いっぺんに全てを語るな! 大雑把な分割から細かい要素へドリルダウン
いっぺんに全てを語るな! 大雑把な分割から細かい要素へドリルダウン

対象読者

  • テクニカルな文章を書いている人/書かなきゃならなくなった人
  • その中でも、とくにソフトウェア開発に関わっている人

 テクニカルライティングの領域は広いですけど、この連載ではソフトウェア開発に関連した文書を主に想定しています。

人のワーキングメモリー容量は4つくらい

 人間のワーキングメモリー(作業記憶)の容量、つまり、いっぺんにぱっと覚えられる物事の数はそれほど多くありません。60年ほど前からいわれている「マジカルナンバー7±2」というのが有名ですが、これは数字だけを頑張って覚える場合です。実際には、せいぜい4つ程度だといいます(Cowan, 2001)。

 ということは、説明するときにアイテムを列挙するなら3つくらいを目安にして、多くても5~6個までにするべきだとなります。それより多いと読者の頭にすっと入っていきません。「分かりにくい」と思われたり、「この列挙は読み飛ばしちゃえ」ともなりかねません。

 では、説明しなきゃいけないアイテムが7個以上あったらどうしましょう? そういうときは、無理やりにでも減らします。説明に必要のないアイテムを削ったりすることもあります。無理にでもグループ化する基準を考え出してアイテムを階層化し、いっぺんに列挙するアイテム数を減らすことも有効です。

PCの構造

 例えば、パソコンはどんな要素から構成されているでしょう。だいたい次のような部品に分解できます。

  • ケース
  • 電源
  • マザーボード
  • CPU
  • CPUファン
  • メモリーカード(主記憶装置)
  • グラフィックカード[オプション]
  • HDD/SSD(補助記憶装置)
  • DVD/BDドライブ(補助記憶装置)[オプション]
  • メモリーカードリーダー/ライター(補助記憶装置)[オプション]

 10個のアイテムが並んでしまいました。すでにパソコンの構造を熟知している人なら、目を閉じてこの10アイテムを言うことも可能でしょう。でもそれは、すでに長期記憶として持っているからできることです。パソコンの構造をまったく知らない人にこのリストだけを見せて覚えてもらうのは、まず無理でしょう。

 さて、どうやってアイテム数を減らしましょうか?


関連リンク

  • ブックマーク
  • LINEで送る
  • このエントリーをはてなブックマークに追加

著者プロフィール

  • biac(ばいあっく)

    HONDA R&Dで自動車の設計をやっていた機械屋さんが、技術の進化スピードに魅かれてプログラマーに。以来30年ほど、より良いコードをどうやったら作れるか、模索の人生。わんくま同盟の勉強会(名古屋)で、よく喋ってたりする。 2014/10~2019/6 Microsoft MVP (Windo...

バックナンバー

連載:テクニカルライティング作法・外伝

もっと読む

All contents copyright © 2005-2019 Shoeisha Co., Ltd. All rights reserved. ver.1.5