DITAでマニュアルを執筆する人のためのファーストステップガイド

はじめに(一部抜粋、要約)

近年、マニュアル制作を取り巻く環境が急激に変化しています。生産性や付加価値の向上が謳われる中、従来のマニュアルの形式および制作方式ではこうした変化に十分に対応できなくなっています。

主な原因の一つは、利用者側の閲覧環境の変化です。

タブレット端末やスマートフォン端末など、利用者のマニュアル閲覧環境が多様化したことで、マニュアルの利用法も、電子媒体ならではの「検索」や「リンク」を使ってピンポイントで参照し、必要な情報を「拾い読み」する傾向が強くなっています。

マニュアルを提供するメーカー側は、従来の機種ごと、OS毎の対応のほか、こうした閲覧環境の多様化に伴うマニュアルのバリエーション対応、グローバル・ビジネスの進化による製品の世界同時出荷を見据えた多言語マニュアルの同時かつ短期制作が求められるようになりました。

DITAによるマニュアル制作は、こうした課題を解決するためのヒントを提示します。

本書は、より多くの方に、マニュアル制作におけるDITA 導入の効果を実感していただくため、一般的な解説にとどまることなく、演習を通じてDITA によるマニュアル制作を体験していただくことを狙いとした内容になっています。

第1章~第6章で、DITA の全体像やDITA によるマニュアル制作のメリット、必要な制作環境について解説しています。第7章では、演習を通じて、DITA で簡単なマニュアルを作成するための一連の操作を体験します。第8章以降では、導入事例の紹介や、DITA の今後の可能性について述べています。さらに付録として実践可能なサンプルや情報集が付いています。

目的に応じてそれぞれの章を参照していくこともできますが、第1 章から順番に読み進めた方が、より効率よく理解できるように構成されています。概要の理解と演習の両面から、是非、DITA の良さ、効果を実感してください。

表紙画像

目次

※各章をクリックすると、節見出しが表示されます。もう一度クリックすると、節見出しは閉じます。

    • DITAとは
    • DITAの歴史
    • DITAの特徴
    • DITAの普及状況
    • DITA によるマニュアル制作のイメージ
    • トピックとマップ
    • トピック指向ライティング
    • DITA の制作方式
    • 要素の構造
    • 階層化
    • XMLの特徴
    • 情報型
    • 特殊化
    • 再利用
    • 自動組版
    • マニュアル制作者のメリット
    • マニュアル利用者のメリット
    • 3 つの構成要素
    • 各構成要素のツール選択の考え方
    • オーサリングツール
    • コンテンツ管理ツール
    • パブリッシングツール
    • 制作環境の組み合わせパターン
    • 演習を始める前に
    • 演習環境を構築する
    • 【演習1】トピックとマップを作成する
    • 【演習2】よく使用するDITA の要素を記述する
    • 【演習3】トピックを再利用する
    • 【演習4】条件や変数を使って出力を出し分ける
    • 【演習5】task 型トピックを作成する
    • 【演習6】トピックを階層化する
    • 演習の最後に
    • 【事例1】部品化と自動組版による編集の効率化
    • 【事例2】共通情報の再利用によるメンテナンス性向上と品質向上
    • 【事例3】ワンソース・マルチデバイスの実現と読みやすさの改善
    • 【事例4】多言語マニュアルの翻訳の効率化
    • 企業のコンテンツの一元管理
    • 利用者ニーズに合った情報をタイムリーに提供
  • 付録Aトピック指向ライティング
  • 付録Bトピックとマップのサンプル
  • 付録C 変換時に発生する主なエラーの原因と対処方法
  • 付録D 参考情報
  • あとがき
  • 参考文献
  • 索引