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

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

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

開米 瑞浩

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

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


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

「IPアドレス」の説明文のリライトシリーズ、第3弾です。
今度はこの文を検討してみましょう。

機器間の通信は、データリンク層とネットワーク層の2つの階層を通して行われる。

おお、かなりの専門用語ですね。ここに書いてある文言だけだと、「ネットワーク層」とか「データリンク層」という専門用語が説明なしに使われているため、予備知識の無い人間にはわかるはずがありません。

必要そうな予備知識を補って図解してみせると、こんなイメージでしょうか。

2014-0530-1.PNG

この図は、

  1. 2つの情報機器間で通信を行うためには、それぞれのアプリケーションプログラム(AP)間でデータが受け渡せなければならない。
  2. AP間の通信はネットワーク層とデータリンク層の2つの階層を通して行われる。

ということを表現しています。
しかし、これだとネットワーク層とデータリンク層の違いがわかりません。
それがわかるようにさらに手を加えるとこんなイメージになりますね。

2014-0530-2.PNG

こう書くと、たとえば「情報機器1と3のAP間で通信をしようとしたら、どういう径路でデータを渡せば良いか?」と問えば、

情報機器1と3は直接接続されてないから・・・・
いったん情報機器2で中継すればいいのかな?
あ、そうすると「ネットワーク層」というのがその中継をしてくれるのかな?

といった推測ができます。「図解をする」というのはこのように、「違いがあるなら違う部分が見えるように書かなければ」ならず、そのためには「どんな違いがあるのかを知っていなければ」なりません。

こうした技術情報を図解するのが苦手という場合、

(1) 単に書き慣れていないだけ
(2) 実は十分な技術知識を持っていない

という2つのケースがあります。
経験的に言うと第2のケースは非常に多いですね。断片的なハウツー知識を知っただけで根本原理を勉強していない方によく見られます。

(続く)