テクニカルライティングの応用

電子マニュアルの考え方とタブレット端末で読める電子版図解マニュアルの作り方


電子マニュアルのコンセプト作り

 

マニュアルの電子化にあたり、「どのような電子マニュアルが読者にとってわかりやすくかつ執筆者にとって作りやすいのか」を再確認しておく必要があります。コンセプトが明確になれば、作成に用いるツールもレイアウトもおのずと決まります。

  • 当コーナーでは、「電子ファイル化されネットワークを通してPCを含む各種の端末で閲覧できるマニュアル」を電子マニュアルと位置付けます。

  • 本稿は、2011年1月現在を基準とした電子文書の作成環境を前提にしています。また、商用文書製作業者あるいは商用文書作成ツールなどに依存せず、印刷文書をワープロで作成するのと同様な簡便さで電子マニュアルを作成することを目標としています。


電子化に際し「忘れかけていた二つの基本要件

電子マニュアルに限らず、すべからく実務文書は「執筆者が意図する表現(レイアウトを含め)が文書に“正確に再現”される」に加え「読者が文書を“主導的に(自身のペースでかつみずからの意識を働かせて)理解”できる」ことが基本要件です。

電子マニュアルにおいても、上記の基本要件が満たされなければ“電子化しただけ”のマニュアル、たとえば「印刷して読まなければならない電子マニュアル」もしくは「しばらく動画を見ているだけの電子マニュアル」に陥る可能性があります。

電子マニュアルを作成するにあたっては、「印刷物あるいは電子媒体を問わず文書によって伝え、文書を理解するとは何か」さらには「文書による表現を別の形態(例:動画)に置き換える際に何を補わなければならないか」を再確認する必要があります。この再確認によってこれから作るべき電子マニュアルの具体像が浮かんできます。


最初の選択:「文書スタイルの電子マニュアル」と「動画マニュアル

マニュアルを電子化する際の最初の選択は、印刷物のレイアウトを継承しつつ電子文書の利点を取り入れた「文書スタイルの電子マニュアル」とするかあるいは動画(実写ビデオ、キャプチャービデオなど)を主体としこれに編集を加えた「動画マニュアル(ビデオマニュアル)」とするかです。

選択のポイントは、マニュアルを構成する際の「基本事項」と「付帯的重要事項」をそれぞれの形式で明示的に表しうるかです。マニュアルのテーマ(目的、読者対象を含む)によっては、基本事項(見てわかる動き、例:OKボタンをクリックする)だけでは表せません。基本事項とともに付帯的重要事項(“読む”によって明示的に表し、利用者の理解と確認が必要)を多く伴う場合があります。

マニュアルの構成要素

基本事項

(“見て”直接的にわかる動き・構成)

付帯的重要事項

(“読む”による理解と確認が必要な事項)

見出しと導入部

主題(この項目で何を理解するのか/達成するのか)

その有効性・必要性および主題の語を理解するのに必要な補足

手順の構成、他の手順との関連性

手順に先立つ注意および準備

手順の段落構成

手順番号+1段落・1指示の構成

手順のグループ化(手順番号+1段落・1告知・複数指示の構成)

条件による分岐(および収束)

指示の構成

指示(対象を操作する)

確認すべき結果、手順を誤った際の対処

例外事項、補足、注意

電子マニュアルの適性

動画マニュアル(数分以内の動画+キャプション・ナレーション)

文書スタイルを基盤にした電子版図解マニュアル

動画を取り入れた電子版図解マニュアル

 

避けるべきは、作り手の論理あるいは都合に偏った発想です。いかなるマニュアルも必要な事項がユーザに明確に伝わってこそ製作した意味があります。

さらに、「図は文よりわかりやすい。動画はさらにわかりやすい」とする際の「わかりやすい」の意味を再考する必要があります。本来は、「伝えるべき実務的な情報には、文より図あるいは動画で表すと明確な部分があり、その一方で図あるいは動画より文で表すほうが明確な部分がある」であり、「読むと見るの相互を組み合わせることが、適切な理解につながる」と解釈すべきです。


当コーナーで目指す電子マニュアル
−「真に印刷物に置き換わる電子マニュアル」−

「文書スタイルの電子マニュアル」も「動画マニュアル」も電子マニュアルの1形態であり1段階と言えます。いずれが是であり、いずれが非であると申し上げあるつもりはありません。電子文書を作成する環境が整うにつれ両者が融合した「動画を効果的に取り入れた電子版図解マニュアル(動き見るとともに読めるマニュアル)」が基本になると考えます。

さらに「動画を効果的に取り入れた電子版図解マニュアル」の先の電子マニュアルとして、“マニュアルならでは”インタラクティビティ(操作のシミュレーション、目的に応じた操作手順の構築、その他)を取り入れた「メタ電子マニュアル(ここでは、操作もしくは行動を表した文書もしくはビデオの概念を超えた高次なマニュアルの意味)」を提唱します。

当コーナーで目指すのは、「真に印刷物に置き換わる電子マニュアル」です。また、「電子化するには工夫を要するマニュアル」です。ごく簡略な手順で構成されたマニュアルならば文書スタイルであっても動画であっても電子化にさほど課題はありません。対して、規模が大きな製品・システムで状況分析と判断を伴う使い方が多いマニュアルを電子化しさらに小さな端末での閲覧を可能にするには、文書スタイルと動画の双方の利点を取り入れる必要があります。文書スタイルと動画それぞれの利点が活かされてこそ、印刷物は真に電子マニュアルに置き換わると言えます。

しばしば、“マニュアルがないと行動できない人”あるいは“マニュアルどおりの行動しかできない人”を揶揄(やゆ)的に「マニュアル人間」と称する場合があります。 もちろん、マニュアルのとおりに行動して何の非もありません。むしろ、マニュアルに示す行動の意味あるいは派生的な対応を示さないマニュアルの作り手に責任があるかもしれません。マニュアルの電子化にあたり、マニュアルで何を伝えるのかを一考する必要もあります。“マニュアル人間化”を助長する電子マニュアルであってはならないはずです。


用語に関する注記−「Webマニュアル」−>

当コーナーでは、電子マニュアルを「文書スタイルの電子マニュアル」と「動画マニュアル」に分類して論じます。一般に用いられる「Webマニュアル」の用語は、「HTML形式(およびXML形式から派生した電子文書用のファイル形式)で構成されたマニュアル」あるいは「ネットワークを通して閲覧できるマニュアル全般(PDF文書、その他)」のいずれともとれるためあえて使用を避けます。ただし、用語としての存在性を否定する意図はありません。

  • 当コーナーで述べる「文書スタイルの電子マニュアル」は、HTML形式あるいはPDF形式などを問わず解説文書(とりわけ図解文書)の構成を基盤とした電子マニュアルを指します。対して「動画マニュアル」は、作業を動画(FLV形式などの動画ファイル)で表し、サイト上あるいはダウンロードして閲覧する電子マニュアルの形態を指します。


次ページに進む(ボタンをクリックしてください)


当コーナー主旨とご閲覧にあたってのお願い

当コーナーは、当社のテクニカルライティングに関するコンサルティングの一部です。

  • 当コーナーの内容を各種の文書作成の参考にしていただくことは作者の意とするところであり、これが皆様のお役に立てば誠に幸いです。ただし、内容の一部あるいは全部の転載(他のWebサイトや他の出版物、等に収録・再配布する) および当著作物の二次使用を禁じます。

  • また、上記の主旨より当コーナーはご覧いただいた方々に議論を呈することを目的としておりません。当社セミナーの開催およびコンサルティングに関するお問合せ以外には、お答えいたしかねる場合がありますのであらかじめご了承ください。

 

山之内総合研究所の出張開催セミナー

セミナー/コンサルティングFAQセミナー基本料金[抜粋PDF版]



実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright:Takaaki-YAMANOUCHI/2002-2011
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
 takaaki@yamanouchi-yri.com