製品のマニュアルが 10冊あり、どの冊にも同じ「電源を切ってから作業してください」という注意書きが入っている。部品の型番が変わったので、10冊を開いて、1か所ずつ直す。直し忘れた 1冊が、そのまま印刷に回る。

こうした文書の悩みの多くは、書く道具や人の注意ではなく、文書の「書き方の形」から生まれています。その形を変える考え方が、情報の構造化です。全3回のこの連載では、構造化とは何か(第1回)、Word やテキスト、Markdown との違い(第2回)、自分の会社の文書に要るかどうかの確かめ方(第3回)を、順に説明します。

身近な例:申込書の住所欄

申込書の住所欄を思い浮かべてください。1つの大きな枠に「住所」と書いてあるだけの用紙と、「郵便番号」「都道府県」「市区町村」「番地」「建物名」と枠が分かれている用紙があります。

書かれる住所は同じでも、あとでできることが違います。枠が分かれていれば、「東京都の方だけ」を数えたり、宛名のラベルを作ったり、郵便番号から誤りを見つけたりできます。1つの枠だけなら、人が読んで判断するしかありません。

枠を分けて、それぞれに名前を付けておくこと。これが構造化です。文書でも、同じことができます。

文書の構造化とは、何ですか

文書の構造化とは、文章を「見た目」ではなく「意味の役割」で区切り、その役割に名前を付けて書くことです。

図見た目で書くか、意味で書くか

見た目で書く

太字で、赤い文字

  • 人が見れば、注意書きだと分かる
  • ソフトには、「太字の赤い文字」としか分からない
  • 注意書きだけを集めたり、まとめて直したりできない

意味で書く

これは「警告」

  • 見た目は、あとから決まりで付ける
  • ソフトにも、「警告」だと分かる
  • 警告だけを集める、まとめて直す、別の冊で使い回すことができる

当社による整理です。

見た目で書いた文書は、人が読むためには十分です。けれども、ソフトや AI には、どの行が手順で、どの行が警告なのかが分かりません。意味で書いた文書は、人にも、ソフトにも、AI にも、同じように役割が伝わります。

役割には、どんな種類がありますか

技術文書の構造化の規格 DITA は、文書の中身を、役割ごとの「情報タイプ」に分けます。基本になるのは、次の 3つです。

図情報タイプの基本の 3つ
  1. 1概念それが何か、なぜ大事か。背景の説明
  2. 2手順何を、どの順番でするか
  3. 3参照仕様や設定の値。表で引いて調べるもの

OASIS の DITA の仕様をもとに、当社がまとめました。

DITA の仕様は、手順にあたる内容は手順の型で書き、背景の説明は手順と分けておくよう求めています。分けておけば、読み手は、必要なときだけ背景を読み、作業中は手順だけを追えます。

構造化すると、何ができるようになりますか

図構造化でできるようになる 4つのこと
  1. 1探せる「警告だけ」「この機種の手順だけ」と、役割や条件で絞り込める
  2. 2使い回せる同じ注意書きを 1か所に書き、10冊から参照する。直すのは 1か所
  3. 3出し分けられる機種、地域、読み手ごとに、要る部分だけを組み立てる
  4. 4形を変えて届けられる同じ原稿から、PDF、Web のヘルプ、AI が読む形を作る

当社による整理です。

DITA の仕様も、トピック(話題ごとの小さな部品)に分けて書く利点として、内容を別の文書で使い回せること、Web 向けと印刷向けで並べ方を変えられること、翻訳と更新を、少ない手間と費用で行えること、必要な部分だけを絞り込めることを挙げています。

どんなときに、構造化が要りますか

すべての文書に、構造化が要るわけではありません。次のような文書ほど、効果が大きくなります。

  • 製品や機種が多く、同じ説明が何冊にもくり返し出てくる。
  • 改訂が多く、直すたびに、関係する箇所を探している。
  • 複数の言語に翻訳している。
  • 同じ内容を、PDF、Web、社内のポータルなど、いくつもの形で届けている。
  • 安全や法規に関わる記述があり、どの冊も同じ文言にそろえる必要がある。
  • 書く人が多く、人によって書き方がばらばら。
  • 社内の AI やチャットボットに、文書を読ませたい。

反対に、一度だけ配る案内や、1人が書いて 1回で終わる文書は、構造化の手間に見合わないことがあります。そうした文書は、Word のスタイルをそろえるだけでも十分です。

構造化は、新しい考え方ですか

技術文書の世界では、20年以上使われてきた考え方です。DITA は IBM で生まれ、2005年に、標準化の団体 OASIS の標準になりました。新しくなったのは、文書を読む相手です。人だけでなく、AI が文書を読むようになり、役割が分かる形で書かれているかどうかが、答えの正しさを左右するようになりました。この点は、第3回で取り上げます。

このコラムで言えないこと

  • 構造化の決まりは、DITA だけではありません。ほかの規格や、会社ごとの決まりで構造化することもあります。
  • 構造化でどれだけ手間が減るかは、文書の量と、同じ内容の重なりの多さによって変わります。

連載「情報の構造化って、何ですか」

まずは、文書を一緒に見てみませんか

構造化が要るかどうかは、文書を見ないと決められません。いまお使いの文書をいくつか見せていただければ、どこから整えると効果が出やすいかを、一緒に確かめます。

関連するページ

出典

確かめる

この記事の内容から、2 問です。選ぶと、その場で答えと説明が出ます。

問い 1このコラムでいう「文書の構造化」に、いちばん近いものはどれですか。

問い 2構造化の効果が出にくい文書は、どれですか。

課題を相談する

読んだ内容を、自社の状況に当てはめたいときは、いまの状況と課題をお知らせください。製品が決まっていなくても、相談できます。大学との共同研究と、教材や文書づくりの支援で得た知見をもとに、進め方を一緒に整理します。

このコラムの内容について相談する

コラムの一覧へ ›

気になる0