オルタナティブ・ブログ > 技術屋のためのドキュメント相談所 >

専門的な情報を、立場の違う人に「分かるように説明する」のは難しいものです。このブログは「技術屋が説明書や提案書を分かりやすく書く」ために役に立つ情報をお届けします。

Apacheの機能説明を図解してみると・・・

»

技術屋のためのドキュメント相談所長の開米です。複雑な情報をわかりやすく説明するためには図に書くことが役に立つ、ので、図解研修を依頼されることがあります。

実際、やってみましょう。
今回はこのテキストを例題にします。

【Apache HTTP Server 】
■2.特徴 - 2.3 モジュールによる機能追加
Apacheの機能はモジュールを追加することで拡張できる。Apacheの核となる「Core」がまずあり、そこへモジュールを追加して機能を拡張する。モジュール名は慣習的に「mod_XXX」と付けられる。XXXは機能の概要名である。例えば「mod_dir」「mod_alias」「mod_setenvif」などとなる。・・(以下略、全文は→ 2.3モジュールによる機能追加 、 Wikipedia日本語版 Apache HTTP Server の項、2014/4/21更新分)

長いので以下略にしておきました。全文はリンク先のWikipediaより「モジュールによる機能追加」の項をご覧ください。

こういう「文章による解説を、図解含みで書き直すトレーニング」を少しずつでもいいので継続的にやっていると、だんだん出来るようになります。
この問題の場合はちょっと原文が長いので20分ぐらいを目処にやってみると良いでしょう。書き慣れてくると5~10分ぐらいでできるようになります。

一例を挙げるとこうですね。

2014-0521-1.PNG

 ↑これが、サクッと短時間で書くラフ案レベルの解説図の一例です。
 大勢に読ませるための説明書なら、これに微調整を加え、さらに図では書き切れない説明文を注釈として加えたほうがいいですが、単発の打ち合わせに使うようなものならこのレベルで十分です。

 しかしながら、「このレベル」を書くのも苦労してしまう、という人も少なくないのですね。

 そこでそんな人にお勧めしたいのは、「おおまかに3つのグループを探す」という方法です。

 「図解」でやることのかなりの割合(経験的に言うと7割ぐらい)は、「分類」なんです。
 前述の例にしても、実は大まかに3グループになっています。

2014-0521-2.PNG 

と、こんな3グループですね。

 3つぐらいにグループ化して、それを分離して書く

ようにすると、それだけである程度役に立つ整理が出来ることが意外に多いので、どこから手をつけたらいいかわからないときは、

     3つに分ける、3つに分ける、3つに分ける

と呪文のように唱えてやってみてください。

また、このような練習問題のワークを通じて「わかりやすく書く技術」を学ぶ講座も開催しております。

↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓

【お知らせ】 

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

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

アイデア・思考を見える化する「読解力×図解力」 スキルアップ研修

主催:中部産業連盟 5月29日 @名古屋

Comment(0)