こんにちは、文書化支援コンサルタントの開米瑞浩です。
原子力論考書いたりiPadケースの改造を書いたりしていると本業を忘れられそうですが、本業は私は「難しいことをわかりやすく書きたい人のための文書化支援」と、それに関連した企業研修をやっています。

たとえばこういう文章について・・・・（以下、原文と呼ぶ）

RSSとは、Webページのタイトル、見出し、要素（本文）、更新日時などの属性（summary）をXMLフォーマットで記述して、各ページの更新情報を公開するためのしくみです。XMLフォーマットで記述されたRSSフィードを、RSSリーダーと言われるソフトに読み込ませることによって、更新情報が自動取得、閲覧できます。これにより、ニュースサイト、ブログなど、自分の関心事に沿った情報を、効率的かつ習慣的に取得することができます。

いや、こういう文を読むとほんの１，２行で挫折する人、多いでしょうね。「XMLフォーマット」というような専門用語が出てくると、その知識を持たない人にとっては「理解する上でのハードル」がいきなり上がるので、「これは私には読んでもわからないんじゃないだろうか」と感じさせてしまい、先を読む気を一気に失わせてしまうのです。

こういう文はたとえばこういう形に書き直すと、（以下、改善案と呼ぶ）

（用途）RSSとは、ニュースサイト、ブログなど、自分が関心のある多数のサイトの更新情報を、効率的かつ習慣的に取得できるしくみです。
（機能）このために、情報を掲載するサイト側は更新情報を共通のフォーマットで公開するようにして、情報を読みたい読者側はその共通フォーマットの情報を効率的に集めてくるうなツールを使います。
（メカニズム）読者側が使うツールをRSSリーダーと言います。RSSリーダーは多数のサイトから情報を集めてきます。その集める情報はどのサイトも共通のフォーマットで公開されています。その共通のフォーマットで書かれた情報をRSSフィードといい、サイトごとにWebページのタイトル、見出し、要素（本文）、更新日時などの情報が含まれています。RSSフィードはXMLという技術を応用して作られています。

そういう「見慣れない専門用語に出くわしていきなり挫折」することを防ぎ、最低限の情報は読んでくれることを期待できるようになります。

原文と改善案を比べてみると、表現の細かな違いもありますが、大きく目につくのは「用途・機能・メカニズム」という３つのキーワードです。実はこの「用途・機能・メカニズム」というパターンは使える機会が多いので、覚えておくと便利ですよ。特に工業製品を説明するときにはよくこのパターンが出てきます。

「用途・機能・メカニズム」というのは、たとえば「懐中電灯をつけるための乾電池」について書くとこんなふうになります。



↓こちらのファイルにはもっと詳しく書いておきましたので、どうぞ参考にしてください。

→開米の文書化研究ノート No.3 「用途と機能とメカニズム」パターンの応用

「開米の文書化研究ノート」　のバックナンバーは下記ページで配布しています。
→開米の文書化研究ノート　コーナー　


■メルマガのご案内■
メールマガジンを不定期に発行しています。
お申し込みはこちら →開米瑞浩の「知識を図解し教える技術」