2012/05/07
[アイデアクラフト] 紛らわしい要素には区別しやすい記号をつける
★ 開米瑞浩の「知識を図解し教える技術」 第510号！ ★ こんにちは。文書化支援コンサルタントの開米瑞浩です。 今日はこんな文面を見ていただきましょう。 情報システムのサポート部署がユーザーの問い合わせに答えた ときの文面です。 まずはざっと軽く流し読みしてみましょう。熟読する必要はありません。 ＜課題原文＞ 先ほどいただいたお電話で、LDAPサーバ兼LDAPクライアントのマシンが1台と それとは別のマシンでLDAPクライアントが1台あり、LDAPサーバ兼LDAP クライアントのマシンで一度ログインしないと、LDAPクライアントのみ のマシンではログインできないというお知らせを受けました。 どちらのマシンの設定にも問題は見つかりませんでした。 現在はAAAにはキャッシュ機能があるため、一度、AAAのキャッシュデータ をクリアしたあと、同様の事象が発生するかの確認をお願いします。 以下の手順で各LDAPクライアントのAAAのキャッシュデータをクリアした のち、LDAPサーバ兼LDAPクライアントのマシンでログインするまで LDAPクライアントのみのマシンでログインできないか確認してください。 ＜課題原文終わり＞ いかにも「読みにくいなあ・・・」と感じませんか？ そう感じる理由は２つあります。 ■背景の文脈共有 １つは、この文書が出てきた背景の文脈を知らないこと。 内容を読むと、LDAPサーバとかクライアントとか、 そういうものを扱っている人同士のやりとりですから、 この文書を送り手と受け手の間ではその文脈は共有されて いるはずです。したがって、当事者にとっては私たち部外者 ほどわかりにくくは感じないはずです。 ですからこの件は当事者同士の連絡文の場合は問題になりません。 ■紛らわしい名前の連発 もうひとつは当事者同士でも問題になります。 たとえば、この文面をさっと軽く流し読みしたところで 次の問題に答えてみましょう。 Ｑ１：どんなマシンがそれぞれ何台ありますか？ これに即座に自信を持って答えるのは難しいはずです。 というのは、よく読めば LDAPサーバ兼LDAPクライアントのマシン LDAPクライアントのみのマシン という２種類のマシンが１台ずつあるということが わかりますが、さっと走り読みしただけでそれに 確信を持つのは難しいはずなんです。 人間の認知能力の特性から言って、「紛らわしい名前」 を連発されると解読に苦労します。 LDAPクライアントのみのマシン という表現が１０行間を置いて出てきた時に、その両者が 完全に同じものを指しているのかどうかは不安になりがち です。 特に専門的な概念というのは紛らわしい略称も多いもので、 もしLDAPだけでなく、LDABという略称で表される概念も あってこんなふうに書かれていたら LDAPクライアントのみのマシン ・・・（１０行ぐらい開ける）・・・・ LDABクライアントのみのマシン 流し読みではどっちがどっちなのかよくわからなくなっても 無理はありません。 そこで、紛らわしい名前、特に「長い名前」を連発するとき にはそれを区別しやすいような配慮が必要です。 具体的にはたとえばこんなふうに書きます。 ＜改善案＞ 先ほどいただいたお電話で、以下の現象をお知らせいただきました。 ＜環境＞ Ａ：サーバ兼用機 LDAPサーバ兼LDAPクライアントのマシン Ｂ：クライアント専用機 LDAPクライアントのみのマシン Ａ、Ｂとも設定には問題なし ＜発生事象＞ Ａマシンで一度ログインした後でなければ、 Ｂマシンにはログインできない ＜原因仮説＞ AAAのキャッシュ機能の影響が考えられます ＜確認依頼＞ 以下の手順でAAAのキャッシュをクリアしたのち、 「発生事象」が再現するかどうかを確認してください 以上。 ＜改善案終わり＞ 「LDAPクライアントのみのマシン」といったベタな表現を 何度も使うとそれだけで紛らわしくなるので、 Ａマシン、Ｂマシンといった記号化を行います。 さらに現象そのものにも「発生事象」というラベルをつけて おいて、同じことを何度も書かずに 「発生事象」が再現するかどうかを確認してください と簡潔に参照できるようにしておきます。 こんなふうに 紛らわしい要素には区別しやすい記号をつける だけでわかりやすくなる文書は非常に多いので、一度、日々の業務連絡や 会社のマニュアル類を見直してみてはいかがでしょうか。 先輩が随時指導していると後輩もこの種の表現に気をつけるように なります。 日常的に意識するようになると、この種の工夫は何の苦もなくできる ようになりますし、職場全体でそういう文化が出来ていると自然に 誰もが真似をするようになります。 でも、その習慣がない職場では自然発生的にこうはならないので、 誰かが率先して進めなければなりません。 そんな「率先して進めたい誰か」のためにこの記事が役に立つ ことを願っています。 ★ ★ ★ その他の事例で「IT技術者が扱う文書をわかりやすく書く」 ライティングのコツを体験的に習得したい方のための放課後 セミナー開催します。５月１１日の夜２時間、お待ちしてます！ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ -------------------------------------------------------------------- ライティング・ワークショップのお知らせ ５／１１ 19:00～21:00 ＠竹橋 ＩＴ文書編 -------------------------------------------------------------------- 「わかりやすく書く力を身につけたい」方のための ライティング・ワークショップ ■5月11日は「IT技術者向きの課題」ということで、 サーバー二重化、Oracle RAC、ファイル監視プロセス の３つの課題を 用意してあります。 課題文書はこちらでご確認を ↓ ライティング・ワークショップ ５月１１日 IT文書編 http://ideacraft.jp/cms/wws/91-wws0511.html どの課題もなかなかに読みにくい書き方がされていますが、それを 「スラスラ読めて、スイスイ頭にはいる」ように書き直すワークを 行います。 「えっ、そう言われても、何をどうすればいいのか・・・難しそうで とてもできる気がしない」と思ったとしたら、そういう方にこそ ぜひ来て欲しいですね。 普段やったことのないことは、出来る気がしなくて当たり前です。 逆に言えばそれは「実際やってみれば、苦手意識が薄れる」という ことでもあります。 ずっと苦手なままでいたいですか？ それとも壁を越えていきたいですか？ 課題文書そのものにはあまりヒントを載せられないので難しそうに 見えますが、現場ではこれでもか！ とヒントをたくさん出しながら 進めますので、手も足もでないようなことには絶対なりません。 その体験を通じて、「あ、これなら出来そう」という感触を つかんでもらうためのワークショップなのです。 「難しそうで私にはできそうにない・・・」と諦めてしまう前に、 試してみてください。 それではまた、お会いしましょう(^_^)/ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 【編集後記】また汗をかく季節がやってくるなあ、と GWも終わって５月も残り３週ちょい。 だんだんと暑い季節が近づいてまいりました。 去年の同時期に比べて体重も10kg以上落ちているので楽にはなって いますが、やっぱり夏は苦手です(^^ゞ 5月7日は98.6kgでした。 80kgまでの道はなお通し（笑） ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ★文書化支援サービスのご案内 専門分野を持つプロフェッショナルが、人に複雑な情報を 説明しなければいけないときに、 「とりあえず書いてはみたけれど、 これで通じるとはとても思えない。 でもどう書いたらもっとわかりやすくなるか 見当もつかない・・・誰かなんとかしてくれ！！」 と思ったら、ご利用ください。 ↓文書化支援サービスのご案内と、文書化研究ノート http://ideacraft.jp/cms/bunshoka.html ちなみに文書化支援といっても、内部統制とかJSOXとか、そういう 方面とはまったくなんの関係もありません。 ほんとは必要もないのに作れと言われるから作る、という そういう文書化ではなく、本当に人にきちんと教えたい、 わかってほしい複雑な情報をわかりやすく書きたい人のための ご相談に乗るのが私のテーマです。 ------------------------------------------------------------------ ★原子力論考もいまだに継続中。 ↓ 原子力論考（４０）「反対運動」が先鋭化する病理をシステム思考的に考察すると http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4320.html 原子力論考（４１）反体制運動のビジネスモデル http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4423.html 原子力論考（４２）風力発電は原発代替にはなりませんので http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4465.html 原子力論考（４３）善意の活動家が陥る承認欲求の罠 http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4535.html 原子力論考（４４）イデオローグとアジテーターの分業関係 http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4556.html 原子力論考（４５）アジテーターは善悪二項対立を演出する http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4568.html 原子力論考（４６）意思決定の負担を拒否する思想の甘い罠 http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4576.html 原子力論考（４７）自然エネルギー利権の誕生 http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4704.html 原子力論考（４８）原子力論考（４８）今こそ太陽光発電に投資しよう！（嘘） http://blogs.bizmakoto.jp/kaimai_mizuhiro/entry/4714.html ★☆★☆ ===================================================================== メールマガジン 開米瑞浩の「知識を図解し教える技術」 発行者 アイデアクラフト 代表 開米瑞浩 発行者Web： http://ideacraft.jp/ アイデアクラフト研修資料室 http://ideacraft.jp/pkw/ 発行者へのご連絡は下記記載のいずれかの手段でお願いします。 http://ideacraft.jp/cms/mission/contact.html E-mail： infox（★)ideacraft.jp (★)の部分は @ に変えてください kaimai.mizuhiro(★)gmail.com skype: ideacraft-kaimai twitter: kaimai_mizuhiro facebook: kaimai.mizuhiro TEL: 042-747-5921 〒252-0318 神奈川県相模原市南区上鶴間本町5-3-19-303 ===================================================================== ☆★☆★ ■アイデアクラフトの事業分野 http://ideacraft.jp/cms/mission/businessdomain.html ■創業のきっかけ・コンセプト http://ideacraft.jp/cms/mission/history.html ■開米の日々のつぶやき twitter: http://twitter.com/kmic67 公式サイト: http://ideacraft.jp/ アイデアクラフト研修資料室: http://ideacraft.jp/pkw/ 誠ブログ: http://blogs.bizmakoto.jp/kaimai_mizuhiro/
