Hatena::ブログ(Diary)

文書遊戯 このページをアンテナに追加 RSSフィード Twitter

2011-05-24

EPUBで技術ドキュメントを書くのは難しそう・・・

| 21:49 | EPUBで技術ドキュメントを書くのは難しそう・・・を含むブックマーク

epubcafeのWEBサイトに、EPUBコンテンツ作成のチュートリアルがあります。非常に分かりやすく書かれていて、EPUB初心者の私でも、EPUB3コンテンツの作成方法を短時間で理解することができました。新しいオープンスタンダードを普及させるにあたっては、こういう情報の提供はとてもありがたいです。

前述のチュートリアルには、SigilというオープンソースのEPUBエディタを使ったコンテンツの作成方法が書かれています。Sigilはとても良くできたソフトウェアだと思います。XHTMLCSSの基礎知識があれば、Sigilを使って簡単にEPUBコンテンツを書くことができます。

これとは別に、以前このブログでも紹介したように、DITAからEPUBを生成することもできます。DITAからEPUBを生成するメリットのうち、最も注目されるのは「ワンソースマルチユース」かと思います。しかし、実際にDITA→EPUB変換で出来上がったコンテンツを見ていて、技術文書についてのワンソースマルチユースは難しそうだなぁという認識を持ちました。

理由を挙げると、

  1. 技術文書には図や表が必須だが、ページの中に読みやすいように図表を配置する術がない
  2. 必要な情報を素早く探して、ピンポイントで読むのが難しい
  3. トピックとマップを同時に見ることができないので、DITAのトピック指向のメリットが生かされなくなる

等々。それぞれの理由をもう少し詳しく説明します。

1.図表の問題

技術文書では、文章だけでは説明が難しい情報を、図や表を使って補足する場面がしばしばあります。このとき、図や表と文章がいっしょに読めるように配置されているのが望ましい姿です。ところが、DITAのコンテンツをEPUBにすると、ページの切れ目がどこにくるのか分かりません。EPUBリーダーでフォントサイズを変えることにより、ページの切れ目も変わってしまいます。したがって、図や表と文章を常にいっしょに読めるようにすることができません。

2.情報取得の効率性の問題

DITAで書いたコンテンツは、必要な情報を見つけやすく、ピンポイントで情報を読める点が売りです。HTMLやHTML Helpで文書を見る場合は、必要なトピックへたどり着くための複数のナビゲーションを利用できます。しかし、DITAコンテンツをEPUBに変換すると、ページをめくりながらツラツラと読まなければいけない文書になってしまいます。

3.マップの問題

DITAはトピックマップの思想を取り入れています。全文検索や索引からあるトピックへジャンプしたときに、マップを見ればそのトピックの位置づけがすぐに分かります(そのようにマップをデザインすべきです)。HTMLやHTML Helpで文書を見る場合は、ツリー形式の目次がDITAのマップを表しています。しかし、現状のEPUBリーダーでは、マップとトピックを同時に見ることができません。

3の問題は、EPUBリーダーの機能が改善されれば解決します。1と2は、コンテンツの書き方を工夫しなければいけません。そして、その「書き方の工夫」はEPUB特有のものになるように思います。となると、ワンソースマルチユースは難しいなぁとなる訳です。

Connection: close