g-menu

Webマニュアル作成術 その1
- Webマニュアルのメリット -

Webマニュアル作成術 – HTML on Word -

近年、さまざまな製品に付属する説明書や業務に関する手順書(業務マニュアル)などは、冊子(紙)からWebページやPDFなど電子文書へ媒体が代わってきています。中には利用者の層や利用する環境、利便性の考慮など諸事情によって冊子としての説明書がなかなかなくせないケースもありますが、そのような場合でも冊子に加えて電子文書の説明書、マニュアルは不可欠なものになっています。

また、エコやコストの観点から紙媒体の削減をしたり、更新にかかるコストを下げるためにも電子文書にすることで大きなメリットがあります。

ここでは、Webマニュアルのメリットと、Microsoft Word(以下、Word)で原稿を作成してWebマニュアルを作成するメリットについてご紹介します。

具体的な作成方法については「その2 -WordからWebマニュアルの作成-」をご覧ください。

マニュアルの種類の例

マニュアルの媒体/フォーマットの例

  • 製品の取扱説明書
  • 製品のクイックガイド
  • 製品の操作ガイド
  • 各種リファレンス
  • 業務マニュアル
  • 各種手順書

など

紙のマニュアル

  • 冊子など紙の媒体に印刷したマニュアル

電子マニュアル

  • HTML(Webマニュアル)
  • PDF
  • EPUB
  • Microsoft HTML Help(CHM)1
  • Microsoft Word形式のファイル
  • 一太郎形式(ジャストシステム社)のファイル
  • その他各アプリケーションの形式のファイル
  • 専用アプリ化したマニュアル2
  • 動画マニュアル3

ヒント

このページは、Wordで文書を作成して『HTML on Word』でHTMLに変換して作成しました。

Webマニュアルとは

Webマニュアルとは、電子文書化された取扱説明書やマニュアルの中でも、Webブラウザーで閲覧できるHTML形式で記述されたマニュアルです。従来は紙で作成されていたマニュアルですが、HTML形式のファイルにしてインターネットやイントラネットで公開することで、いつでもどこからでもWebブラウザーでアクセスし、マニュアルを閲覧できるというメリットがあります。

Webマニュアルとは

Webマニュアルのメリット

取扱説明書や業務マニュアルを紙の冊子ではなくWebマニュアルにすることで、次のメリットがあります。

メリット

1

物理的な保管場所が不要

2

冊子の持ち運びをする必要がない

3

紙に印刷したり、輸送するためのコストがかからない

4

パソコンやスマホなどの端末とネットワーク接続環境があれば、いつでもどこでも閲覧可能

5

パソコン、タブレット、スマホなど、画面サイズに応じて最適なレイアウトで表示が可能(レスポンシブWebデザイン)

6

マニュアルのページを参照する時、ハイパーリンクを使ってすぐにページを移動できる

7

ページ内の文字を全文検索できる。また、Webサーバー上に検索機能を実装することで、あいまい検索や複合的な条件による検索など高度な検索が可能になる

8

作成したWebマニュアルをすぐに公開できる

9

改訂や修正があった場合に、すぐに修正して反映できる

10

動画などマルチメディアを使ったマニュアルを、リンクしたり埋め込んだり4できる

11

外部へ持ち出し禁止の情報の場合、アクセス権限を設定して持ち出しできないように対策ができる

Webマニュアルのデメリット

Webマニュアルには、次のデメリットがあります。

デメリット

1

Webを閲覧するための端末(パソコン、タブレット、スマホなど)が必要

2

端末のバッテリーが充電されているか、電源が確保できる必要がある

3

端末の操作やWebブラウザーの使い方を知っている必要がある

4

インターネットに接続できる環境が必要

5

マニュアルの制作に、(場合によっては)HTMLやCSSなどのWebページ制作の知識が必要

6

公開するためのWebサーバーが必要

「1」~「4」のデメリットについては、昨今では対応している方も多いと思いますので、デメリットにならないケースもあります。また、「5」についてはHTMLやCSSにあまり詳しくなくても制作できる方法が用意されている場合もあります。

「6」については用意されている企業様も多いかと思いますが、Webマニュアルのコンテンツの規模によっては別途専用のサーバーが必要になるかもしれません。

他の電子マニュアルのフォーマットとの比較

フォーマット

Webマニュアルとの比較

PDF

レスポンシブなレイアウトに対応していない。PDFを表示するアプリケーション、またはPDFが表示できるWebブラウザーが必要。また、作成時に作成元のファイルからPDFに変換するアプリケーションが必要。

EPUB

主に電子書籍で使用されるフォーマット。EPUBを表示できるリーダーアプリケーションが必要。また、作成時に作成元のファイルからEPUBに変換するアプリケーションが必要。

Microsoft HTML Help(CHM)

対応環境がWindowsのみ。HTMLと設定ファイルなどをあわせてコンパイルする必要がある。レスポンシブなレイアウトに対応していない。

Microsoft Word形式、一太郎形式、その他各アプリケーションの形式

作成、閲覧に各アプリケーションが必要。レスポンシブなレイアウトに対応していない。

専用アプリ化したマニュアル

各デバイスやOSごとに専用のアプリが必要。作成にはアプリの開発が伴う。また、アプリの配布までに配信サービスへの登録などが伴い、時間がかかる。

動画マニュアル

ファイルサイズが大きくなりやすい。制作に動画編集のスキル、動画編集ソフトが必要。ハイパーリンクや他のマルチメディアの埋め込みなどができない。

HTML形式とPDF形式のどちらが良い?

HTML形式とPDF形式のどちらが良い?

従来は電子マニュアルにおいて「どんなパソコンでも同じレイアウトで見ることができる」、「画面表示と印刷結果が同じである」、「電子メールやWebなどネットワークを介して気軽にやり取りができる」などの理由でPDF形式がかなり浸透していました。

しかしながら、PDFは紙の冊子を模倣している、あるいは紙の冊子の印刷用データを想定した作り/レイアウトになっているため、スマホなど画面の小さな端末で見るには不向きとなります。

スマホが普及している昨今では、表示する画面サイズによって最適化される、レスポンシブなレイアウトが可能なWebマニュアル(HTML形式)が注目されています。

Wordを使ったWebマニュアルの作成

Webマニュアルの作成手段は、CMS5やWebサービスを利用する、DTPソフト6を使用する、DITA7を利用したシステムやアプリケーションを使用するなど制作物の規模や、多言語対応の有無などによって、さまざまな手段が提供されています。

ここでは、比較的導入コストが低く、使い慣れている方も多いと思われるWordを使用して作るWebマニュアルについてご紹介します。

Wordで作成できるHTMLは「使い物にならない」と思われるかたもいらっしゃると思いますが、弊社のソフトウェア『HTML on Word』を使用することで、Wordの便利な文書作成機能を利用しつつ、Webマニュアルとして使用できるHTMLを作成できます。

Wordで原稿を作成するメリット

Wordは導入済みのユーザーも多く、DTPソフトやDITAのように特別なスキルやソフトを必要とせずに文書作成ができます。またCMSやWebサービスのようにシステムを構築したり、あるいはシステム使用料金の必要がなく、導入にかかるハードルが低いメリットがあります。

Wordの機能をフル活用!

また、Wordには文書を作成するためのさまざまな便利な機能があります。これらを利用して文書を作成し、『HTML on Word』でHTMLに変換することで、Wordから作成したとは思えないほど充実したWebマニュアルを短期間で作成することができます。

Wordの便利な文書作成機能の例

など

Wordだけでは実現できない機能を『HTML on Word』で実現!

『HTML on Word』はHTMLへ変換時にWordの機能を使用せず、弊社独自の変換エンジンによりdocxファイルを解析してHTMLへ変換しています。

docxファイルの内部にある情報以外に、独自の解析による変換を行うため、Word自体にない要素を生成して出力することができます。

例えば、索引に対して挿入箇所へのハイパーリンクを自動で出力できます。マニュアルには欠かせない「索引」にハイパーリンクを設定することで、目的の情報を素早く見つけることができます。

Please enter alt text.

『HTML on Word』の製品について詳しい情報は、製品情報ページをご覧ください。

また、製品を30日間お試しいただける評価版のお申し込み、および製品のご購入は以下のリンクボタンよりお進みください。

ページトップ