登場する「関係者」を明記すべき法則
»
こんにちは、文書化支援コンサルタントの開米瑞浩です。
「難しいことをわかりやすく書きたい人のための文書化支援」と、それに関連した企業研修を本業にしている関係で、たとえば↓こういう文章をどうわかりやすく改良するか、という工夫に日夜頭を悩ませています。
扱う題材は同じですが、今日は別な観点から検討してみましょう。
上記の課題テキスト原文には、「どんな関係者が登場するか明記していない」という欠点があります。
その欠点を直した部分だけ掲載すると、こうなります(昨日の改善案から「機能」部分のみ抽出)。
関係者が複数いて、それぞれにある作業を行い、その2つの作業が連携している、というイメージです。これは実際、基本的なところで正しいイメージです。(若干不十分なところもありますが)
「側」という言葉はそもそも「日本海側、太平洋側」のように「あるものを挟んで両方にある」という場合に使われます。「両方」が三方や四方に拡張される場合も含めて、本質的に「複数」のイメージを持つわけです。それを「サイト側」「読者側」のように対照的な表現とともに使うと、読んだときに上図のような「正しいイメージ」を呼び起こしやすくなります。
ちなみにこれが
「情報を掲載するサイトは更新情報を共通のフォーマットで公開するようにして、
情報を読みたい読者はその共通フォーマットの情報を効率的に集めて」
のように「側」という言葉を使わずに書いても、それでも「複数の関係者を明記して対照的に書いてある」ので、上記イメージには容易にたどり着けます。「側」を使うとそれがさらに簡単になるということです。
一方、課題テキスト原文では、「側」のように「複数の関係者がいる」ことを示唆する言葉もなく、どのような関係者がいるかも明記していません。「各ページの更新情報を公開する」のは誰か、「更新情報を自動取得、閲覧する」のは誰か、明記していないわけです。
明記していなくても常識で考えて分かるだろう・・・と思いたいですが、それは書かれていることをよく理解している人間の思い込みです。知識経験が浅い人間にはそのような推定を「自信をもって行う」ことはできません。そこで、
登場する「関係者」は明記すべき
なのです。これをハッキリ書かずに「わかるだろう」と読者が推定できることを期待している文章をよく見かけます。一度、自分が書いたものもチェックしてみてください。
↓この内容はPDFファイルにもまとめてあります。こちらはおまけの余談つき(^_^)/
→開米の文書化研究ノート No.4 登場する「関係者」を明記すべき法則
「開米の文書化研究ノート」 のバックナンバーは下記ページで配布しています。
→開米の文書化研究ノート コーナー
■メルマガのご案内■
メールマガジンを不定期に発行しています。
お申し込みはこちら →開米瑞浩の「知識を図解し教える技術」
「難しいことをわかりやすく書きたい人のための文書化支援」と、それに関連した企業研修を本業にしている関係で、たとえば↓こういう文章をどうわかりやすく改良するか、という工夫に日夜頭を悩ませています。
RSSとは、Webページのタイトル、見出し、要素(本文)、更新日時などの属性(summary)をXMLフォーマッ トで記述して、各ページの更新情報を公開するためのしくみです。XMLフォーマットで記述されたRSSフィードを、RSSリーダーと言われるソフトに読み 込ませることによって、更新情報が自動取得、閲覧できます。これにより、ニュースサイト、ブログなど、自分の関心事に沿った情報を、効率的かつ習慣的に取 得することができます。あれ? 昨日の記事と同じじゃないか、と思われた方、その通り!
扱う題材は同じですが、今日は別な観点から検討してみましょう。
上記の課題テキスト原文には、「どんな関係者が登場するか明記していない」という欠点があります。
その欠点を直した部分だけ掲載すると、こうなります(昨日の改善案から「機能」部分のみ抽出)。
(機能)このために、情報を掲載するサイト側は更新情報を共通のフォーマットで公開するようにして、情報を読みたい読者側はその共通フォーマットの情報を効率的に集めてくるようなツールを使います。↑これを読むと脳内にこんな↓イメージが湧くことでしょう。
関係者が複数いて、それぞれにある作業を行い、その2つの作業が連携している、というイメージです。これは実際、基本的なところで正しいイメージです。(若干不十分なところもありますが)
「側」という言葉はそもそも「日本海側、太平洋側」のように「あるものを挟んで両方にある」という場合に使われます。「両方」が三方や四方に拡張される場合も含めて、本質的に「複数」のイメージを持つわけです。それを「サイト側」「読者側」のように対照的な表現とともに使うと、読んだときに上図のような「正しいイメージ」を呼び起こしやすくなります。
ちなみにこれが
「情報を掲載するサイトは更新情報を共通のフォーマットで公開するようにして、
情報を読みたい読者はその共通フォーマットの情報を効率的に集めて」
のように「側」という言葉を使わずに書いても、それでも「複数の関係者を明記して対照的に書いてある」ので、上記イメージには容易にたどり着けます。「側」を使うとそれがさらに簡単になるということです。
一方、課題テキスト原文では、「側」のように「複数の関係者がいる」ことを示唆する言葉もなく、どのような関係者がいるかも明記していません。「各ページの更新情報を公開する」のは誰か、「更新情報を自動取得、閲覧する」のは誰か、明記していないわけです。
明記していなくても常識で考えて分かるだろう・・・と思いたいですが、それは書かれていることをよく理解している人間の思い込みです。知識経験が浅い人間にはそのような推定を「自信をもって行う」ことはできません。そこで、
登場する「関係者」は明記すべき
なのです。これをハッキリ書かずに「わかるだろう」と読者が推定できることを期待している文章をよく見かけます。一度、自分が書いたものもチェックしてみてください。
↓この内容はPDFファイルにもまとめてあります。こちらはおまけの余談つき(^_^)/
→開米の文書化研究ノート No.4 登場する「関係者」を明記すべき法則
「開米の文書化研究ノート」 のバックナンバーは下記ページで配布しています。
→開米の文書化研究ノート コーナー
■メルマガのご案内■
メールマガジンを不定期に発行しています。
お申し込みはこちら →開米瑞浩の「知識を図解し教える技術」
SpecialPR