索引の自動作成機能

マニュアルやトリセツに索引（インデックス）や用語集を設けるメリット

製造業におけるトリセツ（取扱説明書）のようなマニュアルなどのドキュメントを制作する際には、ユーザの利便性を向上させるためにも必要な情報がすぐに探せるような仕掛けを加えておくことが重要となります。Web上で公開されるHTML形式のトリセツや、電子機器上での閲覧に最適化されたPDF形式のトリセツであれば、ブラウザの検索機能やPDFリーダーにおけるしおり機能などを利用することで、ユーザが目的とする情報に素早くカンタンにアクセスすることが可能となります。しかしながら、トリセツは困ったことや疑問点が生じた時に初めて手に取ることが多いといった、辞書のような使われ方がされる傾向が強く、常日頃からトリセツを熟読しておくという使い方をされない傾向にあります。特に製造業においては、その説明の対象となる工作機械や産業機械、半導体製造装置や試験装置、高性能な家電といった、高機能化された製品類の操作方法を伝えるためのドキュメントという特性上、トリセツの情報量は膨大なものになります。

マニュアルなどのドキュメント内に設置された目次やしおりだけでは、ユーザが知りたい情報がどこに載っているのか正確に特定するのは難しく、見出し文の記述方法の工夫やトラブルシューティングの内容を充実させたとしても、それらによる利便性の向上には限界があります。また、検索機能を利用できるとしても、専門用語や業界独特の用語が多用される技術文書においては、ユーザの悩みを解消できるコンテンツに辿り着くキーワードを見つけ出すのも一苦労であったり、スピーディに的確なキーワードで検索出来るかといえば疑問です。特に一般消費者など、技術文書の用語に不慣れなユーザにとっては目的とするコンテンツに関連する用語を考え付くことは容易ではなく、検索しても困り事や疑問点を解消してくれる情報が載っていないという誤った印象を与えてしまうことになりかねません。これらの課題を解決するためにも、索引（インデックス）をトリセツをはじめとするマニュアルなどのドキュメントに設置することをお勧めします。

索引（index）は古くは百科事典や学術書などの書籍から始まり、今ではコンピュータやインターネット、データベースソフトウエアにおいても用いられています。書籍の巻頭に置かれる目次（table of contents）に対し、索引は巻末に置かれることが多いのですが、掲載量の多い百科事典などは索引だけを分冊することもあります。目次は書物の内容を要約した見出しを順序立てて配列したもので、それぞれの見出しの開始ページ番号も併記します。目次を読むことでその書籍の全体像や流れを把握することができるだけではなく、求めている情報がその書籍のどのあたりに配置されているか、あるいは該当トピックの記述量の目安などを簡単かつ直観的に理解することが可能となります。
一方、索引は基本的には単一の単語もしくは語句で掲載し、アルファベット順や五十音順で配列します。また、その単語や語句がどこに所在するかを示すページ番号を併記します。

索引があると、そのマニュアル内で使用されている主要なキーワードを一度に確認することが可能となるため、索引にざっと目を通すだけで、目的とする情報に近い語句や関連のある単語、類義語などを発見することができます。探したい情報があるはずなのに記述されている箇所に辿り着けず、目の前にある問題を解決できないという不満を解消し、ユーザ満足度を高めるための仕掛けのひとつとなるのが索引の機能となります。

マニュアル用CMS「PMX」が索引制作のコストを軽減します！

マニュアルをはじめとするテクニカルドキュメントにおいて、索引を手作業で作成するためには膨大な手間と時間を要します。索引作成後においても、ドキュメントに改訂が発生するたびに索引に掲載される用語の所在や内容の変更に応じて、ページ番号を修正したり、用語の掲載順番やカテゴリーを変更したりする作業が発生します。用語が所在するページ番号に関しては、改訂対象となった用語だけではなく、その後方に所在する用語のページ番号も改訂の規模によっては変動する場合があり、人力で対応することは大変面倒な作業となります。

マニュアル用CMS「PMX」は、索引制作を強力にサポートする「索引の自動作成機能」を有しております。マニュアルなどのドキュメント完成後のフェーズはもとより、原稿執筆途中のフェーズであっても利用することが可能です。索引の対象としたい用語に、マニュアル用CMS「PMX」のトピックエディタ上のボタン操作にて索引制作に必要な情報を設定することで準備を進めることができます。索引対象となる用語の準備が完了した時点で、索引一覧を自動的に生成することが出来ます。こちらも「PMX」のトピックエディタ上のボタン操作で簡単に実行することができます。マニュアル用CMS「PMX」では、改訂や修正が発生するたびに何度でも索引一覧を作成しなおすことが可能であり、「PMX」上のボタン操作で簡単に新しい索引一覧が自動生成されます。その際、製品名や機能名などに微修正が発生していれば「PMX」が自動的に最新の原稿に記載された名称に置き換えて索引を生成します。また、用語が所在するページ番号についても「PMX」が最新のページ番号とリンクを設置した状態で自動生成します。

このように簡単に索引を作成することが出来るだけではなく、索引一覧を生成するタイミングも自由であるため、原稿のライティング担当と索引制作の担当者を分離することや、それぞれ複数人で様々な箇所の作業を同時並行で進めることも可能となります。

マニュアル用CMS「PMX」には索引制作に必要な情報を設定する機能もあります。ソート順や限定詞（補足や区別のための情報）を、索引制作の初心者でも操作しやすいGUI（Graphical User Interface）画面にて入力設定することができます。この画面におけるソート順は、索引対象となる用語の読み仮名やアルファベット表記など自由に入力することが可能であり、ユーザ側でソートの順番を考えて数値を入力する必要はありません。索引一覧を生成する際には「PMX」が文字コードを判定し自動で並び替えます。

「PMX」が生成した索引一覧情報は、原稿本文と同じようにユーザ側で編集することができますので、カテゴリーごとに固めることや、一部の情報を目的に応じて配列を入れ替えることもできます。また、索引一覧のスタイルはユーザ側で出力用スタイルシート（CSS）を利用することで編集することも可能です。

このように、マニュアル用CMS「PMX」が有する「索引の自動作成機能」を始めとする様々な機能をフル活用すると、ページ数が多いテクニカルドキュメントにおいても、読み手であるユーザが知りたい情報に素早くたどりつくことができる複数の仕掛けを用意しておくことが可能となります。簡単に索引をマニュアルに追加することができますので、工期に余裕が生じ、さらにユーザ満足度の向上に繋がる可能性のある新たな仕掛け作りにも挑戦することができます。例えば、トリセツ（取扱説明書）で使用される言葉の意味を解説した用語集を索引に添えるとユーザの利便性がグッと上がります。また、用語索引だけではなく目的別索引や機能別索引を付属し、困難に直面したユーザが即座に悩みを解決できるトリセツを作ってみませんか？