いつかはやらないと?
マニュアルのWeb化

2024.5.29

シリーズ第3回では、既存のPDF資産を活用するeBookマニュアルについてご説明しました。
シリーズ第4回では、HTML版のWebマニュアルについてご紹介させていただきます。

マニュアルWeb化の進め方 PART2

HTML版Webマニュアルとは

HTML版Webマニュアルは、Webサイトと同じようにHTMLで作成されています。Webマニュアル…と聞き、多くの方が想像するのが、このHTML版だと思います。以下のサンプルは、画面左側に目次を常設し、中央に本文、右側にリンク付きの本文内見出しを配置した Webpageマニュアルです。
※以降、HTML仕様のマニュアルをWebpageマニュアルと呼びます。

Webpageマニュアル
サンプルを見る
  • パソコンやスマートフォンなど、異なる画面サイズに適応するレイアウトを実現します。
  • 動画、音声、画像、アニメーションなどさまざまなメディアを組み込むことができます。
  • 全文検索機能やビジュアル検索、警告一覧など、様々なインタラクティブ要素を組み込むことができます。
  • コンテンツの機能ではありませんが、ブラウザの自動翻訳機能で多言語に切り替えることもできます。

制作・公開までの大きな流れ

ここでは、既存の紙媒体マニュアルからWebpageマニュアル制作までの流れを紹介します。紙媒体マニュアルが存在しない場合でも、原稿は必要となります。紙媒体の目次構成を参考にして、まずは紙媒体レベルの原稿を用意しましょう。制作・公開までの大きな流れは以下のとおりです。

  1. 情報整理

    情報整理

    既存マニュアルに記載されている内容を分割します。難しく考えず、小さなタイトル毎に情報を分割すればOKです。何ページも続く情報があった場合、無理に分割したり、省略する必要はありません。紙媒体では紙面の都合で情報量の制限がありましたが、Web媒体にそうした制限はありません。紙媒体情報はすべてWebpageマニュアルに盛り込み、さらに動画やアニメーションを付加させられる部分を整理しておきます。

  2. 機能検討

    機能検討

    情報検索やレイアウト動作など、Webpageマニュアルに用意したい機能を検討します。インターネット上のサイトで気になる機能を見つけたら、URLを保存して関係者で共有しましょう。最終形のイメージがグッと近づいてきます。

  3. デザイン制作

    デザイン制作

    情報量の多いWebpageマニュアルは、ベースカラーやフォントで変化を付け、現在位置が容易に把握できる工夫が必要です。
    可読性や操作性も考慮してベースデザインを構築します。

  4. Webページ制作

    Webページ制作

    上記までの仕様に合わせてHTML、CSS(見た目の設定ファイル)、JavaScript(動作の設定ファイル)を作成します。この作業をコーディングと呼びます。
    マニュアルの情報は、HTMLファイルにテキストをコピー&ペーストしながら行います。

  5. チェック

    チェック

    コーディングしたHTMLのチェックではなく、実際にブラウザで表示させた内容で行います。デバイスによる表示切替(レスポンシブル機能)がある場合は、パソコン/スマートフォン各々で確認します。リンク先の正誤も確認する必要があります。ただし、リンク切れについては、ブラウザのプラグインやフリーソフトを利用することで、不具合を確認することができます。

  6. 公開

    公開

    以上を経て、制作したWebマニュアルに問題がなければ、晴れて公開となります。
    細かな部分まで全ての説明ができておりません。お知りになりたい情報がありましたら、いつでもお問い合わせください。

マニュアルのWeb化を成功させるために

これは、前回のeBookの場合と同じです。

  • Webpageマニュアルの存在をユーザーへ伝える。
  • 閲覧情報を精査し、Webpageマニュアルの改善や、認知度の向上などに役立てる。

eBookマニュアルとの違いについて

eBookマニュアルとWebpageマニュアルは、ほぼ同等の機能が用意されています。どちらのマニュアルも、閲覧機能や検索機能が実装されており、利便性は同等かと思われます。ただし、eBookマニュアルの場合、元となるPDFと使用するデバイスによっては視認性が低下します。ページ削減などが理由で、情報が詰め込まれたレイアウトは、スマートフォンでの閲覧が少し厳しいかもしれません…。

以上、今回はHTML版Webマニュアル化の進め方をご説明しました。次回は、「効率的なHTML版Webマニュアルの制作方法」についてご紹介したいと思います。