「IPアドレス」の説明文のリライト(1)

誠ブログは2015年4月6日に「オルタナティブ・ブログ」になりました。
各ブロガーの新規エントリーは「オルタナティブ・ブログ」でご覧ください。

»2014年5月22日

IT技術者経験をバックグラウンドに、技術系の専門的な情報を「分かりやすく書く」スキルの指導を得意とするドキュメント・コンサルタント。技術者向け文書作成研修経験多数。

当ブログ「技術屋のためのドキュメント相談所」は、2015年4月6日から新しいURL「http://blogs.itmedia.co.jp/doc-consul/」に移動しました。引き続きご愛読ください。

技術屋のためのドキュメント相談所長の開米です。

今回はこんな技術情報をリライトしてみましょう。

IPアドレスは、IPでネットワーク上の機器を識別するために指定するネットワーク層における識別用の番号である。データリンク層のMACアドレスを物理アドレスというのに対応して、論理アドレスとも呼ばれる。（出典：Wikipedia 日本語版 "IPアドレス" の項、 2014/5/18 更新版）

現代のインターネット技術の基本になっている「IPアドレス」の一番基本的なところの説明です。こういう基本的な説明を必要とする人は、技術知識の無い、簡単に言うと素人さん、あるいはこれから技術者になる勉強をしているところだとしても初心者さんなので、説明の手順を慎重に考える必要があります。

この種のテキストを「初心者にわかりやすくリライトしてください」と依頼されたときにする作業の概要を示すとこんな感じですね。

　原文を読んでまず「ゴール」地点を考えます。ゴールというのは読者が理解した状態のことで、言い方を変えると「読者のアタマの中にどんなメンタルモデルが出来て欲しいか」を考えます。

　その上で、「シンプルステートメント化」ですが、これは説明文を極力「1文で1つのことしか言わない」ものに分解し、不足があれば補う作業です。たとえば、今回の課題文で言うと

データリンク層のMACアドレスを物理アドレスというのに対応して、論理アドレスとも呼ばれる。

これをシンプルステートメント化（長いので、以下、SS化とします）すると

(1) データリンク層の識別用の番号はMACアドレスと呼ぶ。
(2) MACアドレスは物理アドレスとも呼ばれる。
(3) IPアドレスは論理アドレスとも呼ばれる。

　という3つの文になるんですね。
　そしてここで気がつかれたと思いますが、SS化するときに、原文に書かれていない、足りない情報を補っています。上記例で言うと(1)がそれで、原文では「データリンク層のMACアドレス」と一言で片付けられているところを、

データリンク層にも識別用の番号がある。
その番号はMACアドレスと呼ばれている。

　ということがわかる情報を(1)として補っているわけです。

　たいていの場合、きっちりとリライトしようとすると情報が足りないので補う必要があります。「足りない」と分かるためにはその前に「ゴール想定」が出来ていなければなりません。逆に、ゴール想定がしっかりしていれば、足りないものもわかるし、不要なものもわかるので、不要な情報はこの段階で削っておきます。

　そうしてSS化をした上で、最後にビジュアライズ（図解）をします。

　では、今回の課題文をSS化したものを参考に示すとこんな感じになります。

　な、長い！　なんじゃこりゃ！　と思われるかもしれませんが(^^;;
　しかしこれは仕方がないんです。予備知識の無い初心者に対してしっかり理解できるように説明しようとすると、どうしても長くなるものなんです。

　長いように見えても、これでもかなり省略しています。データリンク層とネットワーク層の名前は挙げてますがOSI7階層参照モデルの他の5つは挙げてませんし、データリンクとネットワークの意味の違いも書いていません。

　どこまで書く必要があるかは、この段階で見極めて必要なものを補い、不要なものは削ります。（これがうまく行かないと、一見わかりやすそうでいて肝心なことは何も書いてない解説や、情報が多すぎてつながりが全然分からない解説になったりします。）

　さて、SS化を終えたらそれをビジュアライズ（図解）します。

　少々長くなりましたので、続きは次回へ。

★　★　★　★　★　★　★　★　★

【お知らせ】　

5月29日に名古屋で文章と図解のスキルアップ講座を開催します。報告書、説明書、提案書など、「紙に書く」ことに苦手意識を感じる技術者の方、今年で継続開催7年目になる本講座に参加してみませんか？

詳細・お申し込みはこちら↓

主催：中部産業連盟　5月29日　＠名古屋

ITmediaはアイティメディア株式会社の登録商標です。