「伝える」から「伝わる」マニュアルへ ～マニュアルの分かりやすさと開発効率の向上～ Improving the Readability and the Development Efficiency of Manuals 西端裕一 * Yuichi Nishibata * PFU テクニカルコミュニケーションズ株式会社 ドキュメント開発事業部 PFU テクニカルコミュニケーションズでは，これまで，テクニカルコミュニケーション技術を深耕し，分かり やすいマニュアルづくりに取り組んできた．初心者でも製品を使いこなせるようにすべく，利用者からの問合せ内 容を分析し，マニュアルの体系や提供形態を見直した．同時に，グローバル化する製品のマニュアルの開発効率を 向上するために，次世代の文書記述言語アーキテクチャー「DITA」を活用した． PFU Technical Communications has cultivated technical communication skills and has been engaged in creating easy-to-understand manuals. We analyzed inquiries from users and reviewed the organization and provided media types of our manuals so that even beginners can make full use of the products. At the same time, to improve the development efficiency for globalizing product manuals, we used a next-generation architecture, DITA, for the document description language. 1 まえがき PFU テクニカルコミュニケーションズ（以降，PTE） では，パーソナルドキュメントスキャナ ScanSnap シ リーズをはじめとする PFU 製品やその他様々な企業の 製品のマニュアルを開発している． 近年，ネットワークの普及やデバイスの進化などの環 境変化により，製品の高機能化，多様化が進んでいる． テクニカルコミュニケーターが，分かりやすいマニュア ルをスピーディーに効率よく開発するために日々努力し ている． 本論文では，PFU の主要製品である ScanSnap の マニュアルを例に，分かりやすいマニュアル作成への取 組みと，同時に進めた複数 OS 対応や多言語化に向け た効率化について紹介する． そのため，製品情報を伝達するマニュアルにおいては記 載する情報が増加してきている． また，PTE が担当している製品は，世界各国に向け てWindows注１）やMac OS注２）など複数のOSでグロー バルなビジネスを展開しており，多くのマニュアルを効 率的に開発していくことが必要となっている． これらを背景に，製品やサービスの技術的な情報を分 かりやすく伝達する「テクニカルコミュニケーション技 術」が重要となっており，PTE ではこの技術を持った 注１）Windows は，米国 Microsoft Corporation の，米国，日本 およびその他の国における登録商標または商標である． 注２）Mac OS は，Apple Inc. の商標である． PFU Tech. Rev., 26, 1,pp.31-36 (09,2015) 2 分かりやすいマニュアル作成への取組 み ScanSnap のこれまでのマニュアルは，設置から導 入までを説明した「スタートアップガイド」と，導入以 降の操作を説明した「オペレーターガイド」の大きく分 けて 2 種類である． 「スタートアップガイド」は製品に添付している一枚 ものの印刷物で，1 枚のシートの中に 16 ページ分の情 報を記載している． 「オペレーターガイド」は，製品添 付の DVD からソフトウェアをインストールすると同時 31 「伝える」から「伝わる」マニュアルへ ～マニュアルの分かりやすさと開発効率の向上～ にパソコンに格納される PDF 形式の電子マニュアルで ある．製品がサポートしている Windows，Mac OS の 2 種類の OS で閲覧できるように作成している．ペー ３） 使用中 困ったときの解決方法や活用術について「詳しく」 知りたい ジ数は約 500 ページと多く，機能追加による記載情報 の増加に伴い，ページ数も年々増加する傾向にあった． そこで， これらのマニュアルを分かりやすくするため， 改善に取り組んだ． 2.2 改善 （１） マニュアル体系と構成の改善 利用者のニーズの分析結果をもとに，マニュアルに記 載している情報を分類し，マニュアル体系と各マニュア 2.1 分析 製品の分析や利用者の分析を行い，対象読者の決定， ルに記載する内容を設計した． 設置から導入までの利用シーンでは，従来一枚ものの その読者に適した記載内容，記載範囲，記載順序などを 印刷物である「スタートアップガイド」を用意している． 決定することがマニュアルの企画である．ScanSnap より「簡単に」情報を伝えるためには，記載する情報を のマニュアルの改善においても，まずは製品や利用者に さらに絞り込む必要があると考えた．そこで，マニュア ついて分析を行った． ルに記載していた情報の一部をセットアップ時に表示さ （１） マニュアルの使われ方の分析 まず，利用者視点で分かりやすいマニュアルを作成す るため，PFU の製品サポートセンターと連携して，問 合せ情報をもとに利用者がどのような形でマニュアルを 利用しているかを分析した． その結果，以下の二つの利用シーンでマニュアルをよ く利用していることが分かった． １） セットアップ（導入）時の初期設定，基本操作を 理解するとき ２） 利用中のトラブル発生時に解決方法を調べると き そこで，基本操作と，困ったときの解決方法にたどり つきやすくすることにした． （２） 各利用シーンにおける利用者のニーズの分析 次に，基本操作と，困ったときの解決方法にたどりつ きやすいマニュアル体系と構成，提供形態を検討するた め， ScanSnap 購入後の各利用シーン（購入時， 開梱時， れるウィザード画面に移動し，マニュアルに記載する情 報を減らした．また，効果的に図を活用することで，文 章を削減し，視覚的に情報を伝えるようにした． 導入後の利用シーンでは， PDF 形式の「オペレーター ガイド」を用意し，1 冊に基本操作から詳細情報までを 記載していた．約 500 ページの情報量があり，ページ 数を意識しにくい電子マニュアルではあったものの， 「大 まかに」知りたい初心者には手に取りにくいマニュアル だった．そこで，初心者向けと詳しく知りたい利用者 向けとに情報を分け，2 冊のマニュアルにすることで 1 冊あたりの情報量を減らし，それぞれの利用者のニーズ を満たすことにした．また，初心者向けに基本操作が記 載されているマニュアルを「かんたんガイド」 ，詳しく 知りたい利用者向けに応用操作が記載されているマニュ アルを「活用ガイド」とし，名称からマニュアルの位置 付けが分かるようにした（図 - １参照） ． このように，利用者のニーズを考慮してマニュアル体 設置時，導入時，使用時など）で利用者がどのように考 系を見直した．各マニュアルの記載内容は表 - １に示す えて，どのような情報を必要としているかを，前述のサ とおりである． ポートセンターへの問合せ情報をもとに分析し，まとめ た． その結果，どの利用シーンでも情報を「早く」知りた （２） マニュアル提供形態の見直し より利用しやすいマニュアルを実現するためには，製 品の利用シーンを踏まえてどのような形態で利用者に提 いという時間的な要求は同じだった．しかし，利用シー 供するかも重要である． ンによって，利用者のニーズは少しずつ異なっていた． １） 提供形態の考え方 １） 購入直後（設置，導入） 利用者は， すぐに製品を使いたいと考えており， セッ ルがある．電子マニュアルには，さらに PDF 形式や トアップ方法を「簡単に」知りたい HTML 形式などがある．それぞれの特性を踏まえ， ２） 導入以降 マニュアルの利用シーンに最適な形態で提供すること 目的の利用シーンにあった操作方法や製品の活用方 法を「大まかに」知りたい 32 マニュアルには印刷物のマニュアルと電子マニュア が分かりやすさに繋がると考えられる． ScanSnap は，パソコンと接続して使用する製品 PFU Tech. Rev., 26, 1, (09,2015) 「伝える」から「伝わる」マニュアルへ ～マニュアルの分かりやすさと開発効率の向上～ 利用シーン 新しい情報提供 1. 購入検討 2. 購入 3. 開梱 従来の情報提供 Web情報，カタログ 紹介ムービー 活用術 記載情報の 絞り込み Web情報，カタログ 紹介ムービー 活用術 ・安全上のご注意 ・安全上のご注意 ・スタートアップガイド 利用できないので印刷物で提供することが必要と考え た． そこで，手に取りやすい一枚ものの印刷物という形 態で提供することが最適と考えた．作成したスタート アップガイドは， 紙の折り方にも工夫をし， 操作に従っ ・スタートアップガイド て開いていけるようにした． 「大まかに」基本操作を知りたい利用者にとっては， 4. 設置・導入 印刷物：8ページ 印刷物：16ページ 5. 使用 ・かんたんガイド ・オペレーターガイド ひと目で分かり，探すことなく一つの操作で知りたい PDF：480ページ相当 項目にたどりつけるようになっていることが望まし ・各ソフトのヘルプ い．そこでかんたんガイドには， HTML 形式のマニュ DVD HTML：100ページ相当 DVD 基本 ・各ソフトのヘルプ ・活用ガイド 6. 使用 使い方が分かる 名称に変更 Web HTML：380ページ相当 応用 マニュアルを開いたところで製品の代表的な使い方が アルが最適と考えた．トップページ（表紙）に代表的 な使い方をイラストで示し，詳細な説明のページには ワンクリックでジャンプできるようにした．HTML ・各ソフトのヘルプ 形式であれば検索方法の工夫もできる． ◆図 - １ マニュアル体系と提供形態の改善◆ （Fig.1-Improving the organization and provided media types） 「詳しく」知りたい利用者にとっては，検索性に優 れていることと，活用事例などの最新情報をタイム リーに得られることが望ましい．活用ガイドも，利用 者に最新情報を提供しやすいインターネット公開を前 ◆表 - １ マニュアルの記載内容◆ マニュアル 記載内容 スタートアップガイド 購入後，利用できるまでのセットアップ の方法を伝える． 主に，梱包品の確認，セットアップ方法 と手順，修理お問合せ情報を簡潔に記載． かんたんガイド 活用ガイド 基本的な操作方法を知りたい利用者のた めに，ScanSnap の基本操作を伝える． 主に，製品の操作，基本的な操作，お手 入れの仕方，インストール時のトラブル 対処法を詳しく記載． 詳しい操作方法を知りたい利用者のため に，ScanSnap の活用情報を伝える． ソ フ ト ウ ェ ア の 操 作 と 設 定 方 法， ScanSnap の活用方法を詳しく記載． 提にした HTML 形式のマニュアルで提供することに した． （３） 検索性の向上 （２）で述べたとおり，操作マニュアルは検索性に優 れた HTML 形式で提供することにした．HTML 形式 の特性を活かした検索性向上のための取組みについて説 明する． １） 基本操作の説明への誘導の改善 セットアップを終えた利用者は，次に ScanSnap を操作して，目的の読み取り方法など自分が必要な情 報を知りたいと考えられる．しかし，従来の PDF 形 式のマニュアルでは，目次を頼りに，順番に読み進 めていくしかなかった．基本操作の説明が見つけや すくなるように，HTML 形式のマニュアルではトッ である．そのため，すべてのマニュアルを印刷物とし プページからワンクリックで移動できるよう工夫した て提供するより，同時に使用するパソコンを利用する （図 - ２参照） ．また，初心者が迷わずに操作できるよ ことも有効と考え，印刷物のマニュアルと画面で表示 うに，1 ページで操作説明が完結するようにし，より される電子マニュアルそれぞれの特性に合わせて使い 分かりやすくするために画面と概念図を多用した． 分けることにした． ２） 検索機能の充実とインターネット上の関連情報 ２） 各マニュアルの提供形態の検討 「簡単に」セットアップしたい購入直後の利用者は， へのアクセス性向上 PDF 形式でもキーワードによる全文検索はできる すぐに使いたいというわくわくした気持ちであると考 ものの，検索機能をさらに充実させた方が知りたい情 えられる．開梱して目に入るマニュアルがその気持ち 報にたどりつきやすくなると考え，HTML 形式のマ を阻害しないよう，薄くてコンパクトになっているこ ニュアルでは，利用者がインターネット利用で使い慣 とが望ましい．また，開梱後，設置まではパソコンを れている複数の検索機能を実装した（表 - ２参照） ． PFU Tech. Rev., 26, 1, (09,2015) 33 「伝える」から「伝わる」マニュアルへ ～マニュアルの分かりやすさと開発効率の向上～ 検索方法を説明しているトピックへの リンクを検索フォーム横に配置 検索するキーワードを 予測して候補を表示する サジェスト機能を搭載 代表的な使い方の 説明が見つけやすい ◆図 - ２ かんたんガイドのトップページ◆ （Fig.2-Top page of the Basic Operation Guide） ◆図 - ３ かんたんガイドの検索機能◆ ◆表 - ２ 実装した検索機能◆ 検索機能 Guide） 機能説明 AND 検索 二つ以上のキーワードを入力した場合に，双方 の語句を含むページを検索できる． 完全一致検索 入力したキーワードを半角の「"（ダブルクォー テーション）」で括ると，完全に一致するキー ワードを含んだページを検索できる（入力例： "ScanSnap Manager"）． サジェスト機能 （Fig.3-Search function of the Basic Operation キーワードの入力途中に，そのキーワードを含 む関連キーワードが表示されるため，関連する 情報を見つけやすくなる． 3 効率的なマニュアル開発に向けた取組 み ここまで述べた利用者視点での分かりやすさ向上の取 組みを，限られた開発期間で効果的に行うためには，こ れまで以上に効率的な手法で開発する必要がある． ここでは，効率化に向けた課題を示し，解決するため に実現した取組みについて述べる． また，初めて検索機能を使う利用者のために，使い 方を分かりやすく解説するボタンを設け，活用しても らえるよう工夫した（図 - ３参照） ． 3.1 効率化に向けた課題 ScanSnap は，Windows および Mac OS に対応 HTML 形式のマニュアルに変更したもう一つの理 しており，世界各国向けに提供されている．そのため， 由は，インターネット上に公開している ScanSnap マニュアルは，それぞれの OS 用に，日本語，英語の他， 関連情報へのアクセスのしやすさである． 「かんたん 複数の言語（多言語）で提供している． ガイド」 ， 「活用ガイド」の画面には，製品情報，サポー （１） 複数 OS 対応 ト情報，FAQ，活用情報へのリンクを表示している． 自分のパソコンの OS 用の操作を知りたい利用者が マニュアルを使いながら，最新の製品情報，FAQ， 読みやすいように，一つの操作を説明する場合でも， 活用事例へのアクセスもスムーズに行えるようにし Windows 用と Mac OS 用の記事を作成し，併記して た． いる．そのため，そのような共通記事に修正が発生した このように，利用者の利用シーンと近年の情報伝達形 ときは，Windows 用，Mac OS 用それぞれに同じ修 態の変化に対応して，網羅性と正確性を維持しつつ，マ 正をする必要があった．共通記事率は全体の 7 割となっ ニュアル体系を見直し，検索性を向上させ，分かりやす ていた． いマニュアルの実現を図ってきた． 34 PFU Tech. Rev., 26, 1, (09,2015) 「伝える」から「伝わる」マニュアルへ ～マニュアルの分かりやすさと開発効率の向上～ 3.2.2 DITA 適用における工夫 （２） 多言語対応 マニュアル開発においては，日本語を原典として，日 本語から英語へ，英語から多言語に翻訳している．言語 DITA 適用にあたっては，マニュアル開発関係者の役 割とデータ管理方法を従来のものから変更した． ごとに翻訳と編集を行うため，原典となる日本語を修正 従来，各言語の固有情報は，日本語原典からの翻訳 すると，その都度英語を含む各言語への翻訳と編集が必 後に，その言語担当者が各言語の原稿にそれぞれ反映し 要になる．また，言語ごとに固有の記事があり，各言語 ていた．この方法では日本語原典が変更になるたびに再 で反映する必要がある．したがって，同時に全言語のマ 度反映することが必要になり，手作業での反映作業を繰 ニュアルを提供するには日英多言語のマニュアル開発工 り返すことによって未反映になるおそれがある．また， 程全体の最適化を考えて取り組む必要がある． DITA 適用による各言語での編集の自動化を阻害する要 因ともなる． 3.2 効率的なマニュアル開発 そこで，日本語原典側のコンテンツデータに各言語向 複数 OS 対応と日英多言語全体視点での多言語対応 を効率的に進めるための解決策を述べる． 3.2.1 DITA 注３） の適用 けの固有情報をタグで区別して，日本語ですべて記載す るようにした． 日本語原典側ですべての言語の情報を反映することに 課題解決に向け，以前から取り組んでいた XML （Extensible Markup Language）ベースの文書記述 参１） 言語である「DITA」を採用した ．多言語を含めた DITA の適用は初めての取組みだった． DITA はコンテンツ制作とスタイル設計が独立してお よって，各言語の翻訳者は翻訳に集中でき，編集の自動 化の効果を発揮できるようになった．各言語への出力は， 固有情報も含め，スタイル設計側で制御するようにした． 図 - ４に DITA 適用前と適用後の開発プロセスの違い について示す． り，コンテンツデータはプレーンテキスト形式で管理さ れている． 3.4 取組みの効果 「タグ」という記号を文書の前後に付けることによっ ScanSnap のマニュアル開発に DITA を適用するこ て，文章が持っている意味を分類することができる．そ とで実現した共通情報や固有情報の一元管理により，全 のため，OS 間の共通記事や各言語の固有記事を，タグ 体開発量を 30% 削減することができた．また，各言語 によって区別できるので，データの管理が容易となる． の翻訳編集作業効率は，20% 向上した． また， 翻訳作業を効率化する上でも以下の利点がある． １） 翻訳者はスタイルを意識しなくてもよくなり，翻 訳に集中できる． 4 むすび ２） コンテンツデータがスタイル情報を含まないプ これまで述べてきたとおり，分かりやすいマニュアル レーンテキスト形式になっているため，旧記事と新 の企画や設計と DITA を活用した効率化の取組みによ 記事との変更点を抽出しやすくなる． り，分かりやすさと開発効率の両立を実現してきた． ３） 翻訳したコンテンツデータは別管理されている これらの取組みにより実現した『ScanSnap SV600 スタイルを適用することで翻訳後の再編集が不要な かんたんガイド』が，テクニカルコミュニケーション技 まま，各言語のマニュアルが作成される． 術に関する業界団体であるテクニカルコミュニケーター このように DITA の適用によって，共通記事および 協会が主催する日本マニュアルコンテストにおいて，電 固有記事の管理による重複作業の削減，各言語の翻訳編 子マニュアルの別画面表示部門「部門優良賞」を受賞し 集作業の効率化が実現できた． た．初心者向けのシンプルで分かりやすい構成が評価さ れた． 利用者視点での分かりやすさは，利用者のニーズや環 注３）DITA（Darwin Information Typing Architecture）は， OASIS が策定した XML ベースの国際標準の規格．技術情報の 制作・発行・配布を目的とした XML ベースのアーキテクチャー で，ドキュメントを再利用可能なコンポーネントとして表現す るための標準仕様である．なお，OASIS は，構造化情報標準促 進協会であり，グローバルな情報社会のオープン標準を開発， 統合および採用を推進する非営利国際コンソーシアムである． PFU Tech. Rev., 26, 1, (09,2015) 境の変化によって，追求し続ける必要がある． 今後も，製品情報の「伝える」を考え， 「伝わる」を 創造して，製品の付加価値を向上するためのマニュアル 実現を目指していく． 35 「伝える」から「伝わる」マニュアルへ ～マニュアルの分かりやすさと開発効率の向上～ 従来 日 企画 執筆編集 査読 修正 査読 修正 査読 修正 ・・・ 差分抽出 ・・・ 編集 査読 翻訳 編集 企画 翻訳 編集 翻訳 DITAの適用 査読 編集 翻訳 差分抽出 英語固有情報反映 多 日 翻訳 査読 翻訳 編集 英 ・・・ 各言語固有情報反映 言語固有情報反映 執筆編集 査読 修正 査読 修正 査読 修正 ・・・ 差分抽出 （自動化） 多 編集工程短縮 差分抽出短縮 翻訳 翻訳 査読 翻訳 査読 英 翻訳 ・・・ 差分抽出 翻訳 査読 翻訳 ・・・ ◆図 - ４ DITA 適用前と適用後の開発プロセスの違い◆ （Fig.4-Differences in the development process before and after the application of DITA） 参考文献 参１）竹森ほか：次世代の文書記述言語アーキテクチャー「DITA」 導入によるコンテンツ制作の効率化 , PFU Tech. Rev.,24,1, pp.33-40(2013)． 36 PFU Tech. Rev., 26, 1, (09,2015)
© Copyright 2024 ExpyDoc
