取扱説明書作成に使用するソフトウェアとは?

序章

取扱説明書を作成する場合、文字の入力やレイアウト編集をするためのソフトウェアが必要となります。使用するソフトウェアは、取扱説明書の種類やページ数、レイアウトスタイル、対応言語、作成などの手法によって異なります。

本記事では、取扱説明書の作成現場で使用されている代表的なソフトウェアについて事例を交えて解説します。

一般的な文書作成ソフトウェアを使用する

企業内で社員向けの連絡文書を作成したり、規程や契約書などの定型化文書を作成したりする場合、代表的な文書作成ソフトウェアとしてMicrosoft Word(以下Wordと表記します)があります。

Wordは全世界で使用されている圧倒的なシェアを持つ文書作成の標準ソフトウェアで、日本でも多くの企業がWordを社内の標準ソフトウェアとして使用しています。

Wordには文書を作成するための基本機能に加え、スタイルの作成、文章校正、変更履歴の記録、文書比較など、取扱説明書を作成する上でも役立つ機能が備わっています。レイアウトにこだわりを持たない一般的な取扱説明書を作成する場合、Wordが使用するソフトウェアの第一選択肢となります。B2B製品(産業用機械など)の分野では多くの企業がWordを使用しています。

前述のように、Wordは全世界で使用されており、国内の企業間はもとより、海外の企業間との文書のやり取りを行う上で、データ互換性の面で利点を持っています。

一般的な「章節項」の構造を持つ取扱説明書の場合、一つの章のページ数が100ページを超える場合や、全体の合計ページが500ページを超えるような場合は、ブック型の文書の扱いに適した他のソフトウェア(次項を参照)を使用することも選択肢となります。こうしたソフトウェアでは、目次や索引を自動生成機能も備わっており、取扱説明書作成の効率化につながります。

編集に特化した専門的なソフトウェアを使用する

B2C製品(家電品など)を対象とした取扱説明書では自由なレイアウトやページデザインが必要となる場合があります。このような場合以下のソフトウェアが日本でも多く使用されています。

Adobe InDesign(Adobe社)

Quark XPress(Quark社)


これらのソフトウェアでは、Wordやテキストエディタなどで先に文書を入力し、テキスト文書を流し込んでレイアウトおよびページ編集をする使い方が一般的になっています。


OA機器、建設機械、自動車など、取扱説明書の合計ページが500ページを超えるようなブック型の取扱説明書では、以下のソフトウェアが日本でも多く使用されています。

Adobe FrameMaker(Adobe社)

Adobe FrameMakerは大規模な構造化文書(次項参照)にも対応しており、多言語対応、ブック編集、XML対応(DITAにも対応)など、取扱説明書を作成する上での基本機能に加え専門的な機能が多く備えられています。

マークアップ言語(XMLなど)に対応したソフトウェアを使用する

マークアップ言語(XMLやHTMLなど)によって一定のルールのもとに記述された文書を構造化文書と呼びます。構造化文書では、文書の構造や要素にあたる部分にタグを用いてコンテンツを記述します。

構造化文書(XML文書)の記述例

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sec1 PUBLIC "-//Daitec//DTD FTDML V11//EN" [ ]>
<SEC1 PRIORITY="TOP">
  <TITLE ID="b0408-00-00-00"> 印刷の準備 </TITLE>
<SEC1BODY>
 <PARAGRP> 
 <PARAITEM>
  <PTEXT> 印刷を開始する前に以下の項目について準備を行います。 </PTEXT>
 </PARAITEM>
 </PARAGRP>
<SEC2>
  <TITLE ID="b0408-01-00-00"> 用紙の準備 </TITLE>

XML文書では、文書のスタイル(書式やレイアウト)を分離し、文書の構造および要素とコンテンツのみを記述します。テキスト入力により文書を記述することが可能になるため、入力および編集するソフトウェアに依存しないのが特徴になります。


文書のスタイル(書式やレイアウト)については、XML文書に対応したフォーマッターや変換ツールを使用してスタイル付けを別工程で行います。
文書のスタイルとコンテンツを分離することで、XML文書からHTML文書やPDF文書などへ変換することが容易になり、ワンソースマルチユースの利用方法が実現します。


実際にXML文書の入力を行う場合、タグを含めた文書の入力は、Wordやテキストエディター上で行うには労力が必要となるため、XML文書の入力に対応したXMLエディターを選択することになります。XMLエディターの中には、フリーソフトウェアとして使用できるものもありますが、以下の市販ソフトウェアが日本でも多く使用されています。

Oxygen XML Editor(Syncro Soft社)


また前述のAdobe FrameMakerをXML文書の入力および編集のためのソフトウェアとして使用することが可能です。Adobe FrameMakerはフォーマッターも兼ね備えているので、入力から出力までの工程を一つのソフトウェアで行うことが可能です。

まとめ

これまで見てきたように取扱説明書の作成に使用するソフトウェアは、作成する取扱説明書の種類、ページ数、レイアウトスタイル、対応言語、作成手法などによってどれを選択すべきかわかってきました。

クラウドサービスの普及と進化に伴い、取扱説明書の作成をクラウド上のWebサーバを利用して行うサービスを提供するシステム会社も登場してきました。

またXMLを利用した取扱説明書の作成については、国際標準規格となっているDITA(Darwin Information Typing Architectureの略)を利用する企業も増えてきました。

インターネットを使って取扱説明書のデータを配信する企業も増えており、インターネットブラウザに対応したデータ作りも必要となっています。

ダイテックでは、製造業のマニュアル作成改善を検討する際に、考慮すべきポイントをまとめた入門資料「安心と安全をカバーするマニュアルづくり 3つのポイント」「なぜ読むマニュアルから『見る3Dマニュアル』が増えているのか?わかるガイド」をご用意しました。本資料は、マニュアル作成改善をしたい方には必見の資料です。ぜひダウンロードいただき、ご覧ください。

安心安全をカバーする・マニュアルづくりの3つのポイント
お役立ち資料

この資料は、マニュアル作成するうえで知ってもらいたい基礎的な情報を提供するものです。
「何故、マニュアルが必要なのか」「何に従って、何を書けばよいのか」「情報をどうやって伝えていくのか」等の情報を、初めてマニュアルを作成する人に向けて解説しています。
サンプル目次、ISO/IEC82079のチェックリスト、テクニカルライティングチェックリスト、見直し事例等、私たちのノウハ ウや考え方の詰まった貴重な資料です。是非、ご覧ください。

ブログマニュアル作成取扱説明書