誠ブログは2015年4月6日に「オルタナティブ・ブログ」になりました。
各ブロガーの新規エントリーは「オルタナティブ・ブログ」でご覧ください。
説明文を書く前に専門用語のリストを作ろう
技術屋のためのドキュメント相談所
説明文を書く前に専門用語のリストを作ろう
IT技術者経験をバックグラウンドに、技術系の専門的な情報を「分かりやすく書く」スキルの指導を得意とするドキュメント・コンサルタント。技術者向け文書作成研修経験多数。
当ブログ「技術屋のためのドキュメント相談所」は、2015年4月6日から新しいURL「http://blogs.itmedia.co.jp/doc-consul/」 に移動しました。引き続きご愛読ください。
技術屋のためのドキュメント相談所・所長の開米です。
今回は、「専門用語のリストを作ろう」という話です。
「専門用語をどこまで使っていいのかわからない」というのは、専門的な内容を非専門家に説明するときに非常によくある悩みです。素人向けに話をするとき、専門用語なしで説明できれば話は簡単なのですが、なかなかそういうわけにはいきません。
というのは、「専門用語」を使わずに説明することにはこんなデメリットがあるからです。
- 他の場面でも使われる日常用語だと、そのイメージが紛れ込んで誤解を与えやすい
- 専門用語を知らないと、専門家とのコミュニケーションに困る
たとえばマウスを使うときには「クリック」という操作をしますが、この「クリック」だって本来は専門用語です。だからといって、「専門用語は覚えたくないから、クリックという用語を使わずに説明してくれ」という初心者がパソコン教室に来たら、その要望どうりにするべきでしょうか?
もしそうしてしまうと、その初心者はその後いろいろな人にパソコンの使い方のサポートを受ける時に「話が通じない」ので、間違いなく本人が困ることになります。専門用語は短い名前で特定の概念を誤解なく指示できるので、本来は短時間で正確にコミュニケーションをするために便利な道具です。程度をわきまえる必要はありますが、積極的に使うべきです。
ただし、使うときには最低現、「専門用語のリストを作る」という準備はしておきましょう。
段取りとしてはこうなります。
最後のStep3 「説明文を書く」というのを先にしてしまうことが多いのですが、ある程度複雑なことを説明するときには Step1 ,2 から順番にやったほうがいいのです。
Step1 「必要な専門用語のリストを作る」というのは、たとえばパソコン操作の説明だったら、ファイル、フォルダ、マウス、クリック、ドラッグ、メニュー、といった用語をリスト化しておくということです。
Step2 「用語の依存関係を見極める」というのは、たとえばフォルダとファイルの間には、「ファイルを分類してまとめておく場所がフォルダである」 という関係があります。ということは、「ファイルの説明をしてから、フォルダの説明をする」べきなのです。
用語の依存関係を見極めると、どの順番で説明すれば一番理解しやすいかを判断することができます。知らない用語が一度に二つ以上出てくると、人間にとっての理解のハードルが一気に上がるため、用語の依存関係を見極めるのは、わかりやすい説明をするためには非常に重要です。
そして、「用語の依存関係を見極める」ためには、そもそもその前に「どんな用語を使うか」がハッキリしていなければならないので、Step1 が必要なわけです。
その上で最後に Step3 「説明文を書く」があります。簡単な概念だけなら1,2を省略していきなり Step3 だけをやってもなんとかなりますが、ある程度複雑な話になってきたら Step1からやってみるとよいでしょう。
質問、ご意見等はtwitter, facebook, メール等で私宛にお尋ねください。
→ 開米へのお問い合わせ先
http://ideacraft.jp/cms/main-contact.html
なお、この誠ブログ全体が本日をもって更新停止となり、同じITmedia社の運営するオルタナティブブログに移行するため、この「技術屋のためのドキュメント相談所」 誠ブログバージョンもこの投稿を最後に更新を停止します。今後は引き続き、オルタナティブブログのほうでご覧ください。
(「技術屋のためのドキュメント相談所」 オルタナティブブログ版の開設・更新開始は4月6日以降になります)