タグ別アーカイブ: DITA

DITA で WebHelp を作る

マニュアルを制作するにあたり「PDFよりもHTMLを優先したい」という声が最近増えて来ました。自動組版エンジン AHFormatter を開発している弊社としては、あまり面白くない話なのですが(笑)時代の流れには逆らえません。

タブレット端末やスマホがここまで浸透した今、固定レイアウトの PDF や紙マニュアルよりもリフロー型の HTML の方がニーズにマッチしているのでしょう。弊社でもレスポンシブな HTML の作成方法についてすでに研究を開始していますし、弊社の WEB サイトのレスポンシブ化もほぼ完了しています。

とは言え「紙マニュアルは絶対に必要。停電したときでも読めなければいけない。紙は最後の砦」このような、とあるプラントメーカー様の声もあります。

さて、そんな昨今ですが、DITA コンソーシアムジャパンの中に「DITA for WebHelp 研究部会」というものが立ち上がり、7月5日に最初のミーティングが行われました。

  • DITA から作成した WebHelp の実態を調査し、課題を明確にする
  • DITA から使い易い WebHelp を作るためのガイドラインを作成する
  • DITA から WebHelp 変換のプロトタイプを開発する

このような目的を掲げています。どのような研究成果が得られるか楽しみです。

CIDM(コンテンツマネジメントと情報開発のベストプラクティスに焦点を当てた会員組織)の調査によると、今年ついに HTML パブリッシングの方が PDF パブリッシングよりもわずかに多くなったようです。
この流れは確実に大きくなりますね。


構造化文書とは何か?

新年、明けましておめでとうございます。

弊社では、2016年の課題のひとつとして、構造化文書の普及促進に重点的に取り組む予定です。構造化文書とは、文書の構造をマークアップした文書のことです。

では、文書の構造とはなんでしょうか? どんな意義があるのでしょうか?

文書構造の一つに、階層構造があります。2015年の暮れにJEPAのebookpediaで「階層構造とは」という用語解説が発表されました。この用語解説は人気抜群なのだそうです。

ebookpedia「階層構造とは」

主に電子書籍の階層構造について説明したものですが、簡単に整理すると次のようになるでしょう。

1.階層構造とは、章・節・項のような、つまり、大見出し、中見出し、小見出しのような見出しをつけること

2.階層構造は、XHTMLの<section>, <h1>~<h6>のようなタグで付ける。

3.階層構造の見出しによって、文章の持つ意味や重要度を差別化でき、読み手に意味の重要度が伝わる。また、目次を作ることができる。

4.タグに対して、スタイルシート(CSS)で重み付けと視覚的表現を紐づける。CSSを書き換えることで、見出しの色やフォントを切り替えられる。

この用語説明で、階層構造とはなにか? どんな意義があるかが大雑把に分かります。電子書籍のような簡単な出版物では、この程度の理解で十分かもしれません。しかし、電子書籍についていえば、eboookpediaでも少し触れられていますが、階層構造のような簡単な概念さえ、様々な見解があって必ずしも完全に合意されているわけではないようです。

文書の著者・編集者・制作者は、何らかの構造を念頭に置いているでしょう。これを暗黙ではなくて、明示的なルールでマークアップしたときに、構造化文書となります。タグはマークアップ手段のひとつです。

ところで、階層化以外の構造もあります。例えば、DITA(Darwin Information Architecture)では、技術文書を対象にして、構造についてもっと高度に定義しています。高度な構造は作成に手間がかかりますが、それなりの効果もあります。DITAにおける構造については、後日別途検討する予定です。

続きは:あらゆる文書には構造がある?

[参考資料](用語解説)

1.マークアップとは

2.DITA


「ここだけ」の実践DITAセミナー

おはようございます。
昨日はDITAオーサリングツールXMetaLV7.0を紹介したつながりで、今月開催されるDITAセミナーについて、紹介します。

「ここだけ」の実践DITAセミナー

12月7日にDITAセミナーを開催します。今回もナビックスさんとの共催です。
「ここだけ」の実践DITAセミナーは毎回人気で、いつも募集定員がいっぱいになってしまいます。ありがたいことだと思うと同時に、DITAへの関心の高さには驚いてしまいます。
今回は「多言語展開を見据えたDITA」「多言語組版の基礎知識」の2本立てのセミナーです。
やっぱりDITAと言えば多言語がキーワードのひとつになりますね。
すでにお申込み数が定員を超えてしまったのですが、どうやら同じ内容で年明けにもう一度開催することになったようです。
今回お申込みできなかった方は定期的に弊社のサイトにお越しいただきチェックしてくださるとうれしいです。
●セミナー詳細
「ここだけ」の実践 DITA セミナー ~ DITA の多言語展開-翻訳手法と組版を学ぶ~
どうぞよろしくお願いいたします。


「DITAの不安」

昨日に引き続き、XML関連の営業担当です。
DITAに興味はあるがなかなか採用を決断することができない、という方もたくさんいらっしゃいます。
DITAフェスタで発表された事例紹介の中でも、DITA導入前に感じた不安の話が出てきました。いくつか代表的なものを抜き出してみましょう。
* ブック指向からトピック指向に変える必要がある
* DITAの考え方は従来の紙マニュアル(ブック指向)と異なっており、多くのライターがその考え方に慣れない
* 一つのタスクトピックに複数の手順を書くことができない
* 単一言語(日本語のみ)でも効果があるか?
* トピックを交換可能な部品としてとらえる必要がある
最後の「交換可能な部品としてとらえる」というのはもう少し具体的に言うと、「様々な形式で再構成される」「複数のメディアで利用される」「複数の製品のマニュアルで利用される」というようなことの可能性があるということを常に意識しながら執筆しなければならない、ということになるかと思います。
たしかにDITAというのは一度書いたトピックはとことんしゃぶりつくすという思想ですので、それを実現させるには今までよりも気を使わなければいけないこともあるでしょう。
さて、そんなDITAですが、エプソン・アメリカがDITA導入後3年間の定量的測定をしたところ次のような結果が出たそうです。
* 70-90%のプロジェクトからプロジェクトへの再利用率
* 50%のソース・コンテンツと改定履歴の調査時間の削減
* 4ヶ国語に対するフォーマット時間の短縮
* 40%の生産性の向上
* 70%の翻訳コストの削減
また農業機械メーカーのAGCOによると(82%が共通のエンジンなので)
* 15%のオーナーズ・マニュアル削減
* 18%のワークショップ・マニュアル削減
なのだそうです。
こんなにうまく行くケースばかりではないとは思いますが、ちょっと無視できない話ではあります。
それからDITAの利用率を地域別にまとめると、北米 72%、ヨーロッパ 22%、アジア 4% だそうです。さすがアメリカはフットワークが軽いですね。


「DITAの理由」

こんにちは。XML関連の営業担当です。
1ヶ月半ほど前になりますが、恒例のDITAフェスタが7月12日に開催されました。今回も100名を超える方々にご参加いただき、DITAへの関心の高さを再確認することができました。
今までのDITAフェスタでは「トピックって何?」「conrefって何?」みたいなDITAの仕様の話が散見されましたが、今回は事例紹介中心の内容となり、参加いただいた方からも「事例の話がたくさん聞けてよかった」という声を多数いただきました。
当然「最近DITAの勉強を始めたばかりです」という方もいらっしゃいます。そういった方々にも満足していただけるにはどうしたらいいか、真剣に考えないといけませんね。
さてその事例紹介ですが、前半はエプソンアメリカ、AGCO、IBM、富士通ネットワークコミュニケーションズ、フリースケールセミコンダクター、シトリックスなどなど海外での事例の話で、後半はNECインフロンティアさん、日本電気さん、NECデザイン&プロモーションさんといった国内からの事例紹介となりました。
その中から、なぜDITAなのか、という部分を抜き出してみると…
* 翻訳コスト削減をしたかった
* 紙以外のメディア(iPad、WebHelpなどなど)にも対応する必要に迫られた
* オープンスタンダードな仕様で安心したかった
* ベンダーの縛りから逃れたかった(使っていたツールセットがもうサポートされていない)
* 執筆者によるばらつきをなくしたかった
* ファイル間のコピー&ペーストをやめたかった
といったあたりが共通項として浮かび上がるようです。
じゃあ、DITAを採用すればすべてがうまく行くのかというと、成功させるためにはそれなりの覚悟と努力が必要です。
明日は正反対のテーマ「DITAの不安」に触れてみたいと思います。


DITA超入門 ― まとめ

こんにちは。DITAの話は今日でいったんおしまいにします。
昨日までの4日間で漏れてしまった話題について、軽く紹介しておきます。
■conref
昨日、条件処理を使ってコンテンツの一部を出したり出さなかったりをする方法を紹介しましたが、conrefは他のトピックの中のほんの一部を流用する機能です(フラグメント単位での再利用)。
製品名とかコピーライト表記をひとつのトピックファイルにまとめておいて、それを参照したりするような使い方をします。
■関連テーブル
どのトピックとどのトピックが関連し合っているのかを、それぞれのトピックの中ではなくマップの中に記述することができます。
トピックの中に関連情報を書くこともできますが、そうするとトピック間の関連関係が変更されたとき、トピックをこつこつと変更しなくてはなりません。それはそれで大変なので、マップに追いやってしまおうというわけですね。こうすることでマップだけを修正すればいいことになります。
■keyref
これは参照先をマップで解決しようという機能です。言葉で説明するのは難しいのですが、図式化すると次のようになります。

トピックの中には具体的な参照先は書かないで、マップに書いてしまおうということですね。
この機能は最新のDITA1.2仕様で追加された機能です。一度書いたトピックはできるだけ変更しなくてもいいようにしよう、可変データは可能な限りマップに追いやってしまおう、というDITAの設計思想が感じられます。
■DITA Open Tookit
せっかくマップやトピックが用意できたのに、これをどうやってHTMLやPDFにすればいいんだろう、という疑問がありますよね。大丈夫です。マップやトピックを処理して最終成果物を作ってくれる「DITA Open Tookit」という処理系がすでにあります。オープンソースで誰でも無償で使うことができます。入手先は下記です。
http://sourceforge.net/projects/dita-ot/
Open Toolkitは
  * トピックファイルや画像などの素材を集める
  * 条件処理を解決する
  * conrefやkeyrefを解決する
  * PDFやHTMLを作る
といったことを自動的にやってくれます。
■期待するレイアウトを実現するには
Open Toolkitを使えばPDFを作ることはできるのですが、あくまでもサンプル程度です。
これを期待したレイアウトにするにはそれなりのカスタマイズが必要になります。具体的にはPDF生成用のXSLTスタイルシートを作らないといけないのですが、弊社ではこのスタイルシート作成を請け負っていますので、ぜひご相談ください。
また、Open Toolkitには標準で自動組版エンジンが付いてくるのですが、正直な話、機能的にいまいちです。特にまじめに日本語組版をしたいということであれば、Antenna House Formatterが必須になります。
■お問い合わせ
DITA導入についてのお問い合わせをお待ちしております。
営業担当:小林(guten@antenna.co.jp)までよろしくお願いいたします。
では、5日間ありがとうございました。
最後に関連情報のリンクを少しだけ
OASIS DITA仕様(英語サイト)
DITA News(英語サイト)
DITAコンソーシアムジャパン(日本語サイト)
アンテナハウスDITAサービス(日本語サイト)


DITA超入門 ― 特殊化ってなに?

こんにちは。今週のDITA超入門も、残すところ、あと1回です。
今回は特殊化の話題です。
「DITA」の最初の「D」は(進化論の)ダーウィンの頭文字から来ていますが、ずばり、特殊化という機能があるがゆえにダーウィンの登場というわけです。
昨日までに紹介した機能は、名称や形こそ違え、似たようなことは昔から行われてきました。しかし特殊化という機能はおそらくDITAが最初ではないでしょうか。
■特殊化
特殊化とは既存の情報タイプ(トピックタイプ)を自分が好きなように拡張することです。たとえばdocbookでドキュメントを記述するとき、docbookの仕様の中で定義されている要素をそのまま使うしかありませんが、DITAの場合、都合のいいように要素を定義し直してもいいよ、と。もちろんある程度の制限というか作法のようなものは守らなければいけませんが。
生物は環境に適したものが生き延びる、というのが進化論の教えるところですが、情報タイプもあなたの環境に応じたものを用意していいですよ、というわけです。
次のような手順を出力したい、としましょう。

1. 電源スイッチを押す
2. [ラジオ]ボタンを押す
3. チューニングレバーを回す

もっとも初歩的な解決方法は次のようなトピックを用意することです。
<topic>
  <title>ラジオの聴き方</title>
  <body>
    <ol>
      <li>電源スイッチを押す</li>
      <li>[ラジオ]ボタンを押す</li>
      <li>チューニングレバーを回す</li>
    </ol>
  </body>
</topic>
もちろんこれでも期待する結果は得られますが、では次のような例はどうでしょうか。
<task>
  <title>ラジオの聴き方</title>
  <taskbody>
    <steps>
      <step><cmd>電源スイッチを押す</cmd></step>
      <step><cmd>[ラジオ]ボタンを押す</cmd></step>
      <step><cmd>チューニングレバーを回す</cmd></step>
    </steps>
  </taskbody>
</task>
前者は番号付き箇条書きであることは分かりますが、どういった意味の箇条書きであるのかまでは分かりません。それに対して後者の場合、単なる箇条書きではなく、何かの「手順」であるということがはっきりと分かります。どちらの方が情報の質が上かと言えばもちろん後者ですよね。
このように、それまでは<ol>を使うしかなかった状況から、(情報の質を高めるために)<steps>を使える状況に拡張することが特殊化です。
あ、これは<ol>に限ったことではなく、別の要素だって特殊化の対象になりえます。
■情報タイプ(トピックタイプ)
DITAにはすでに下記の情報タイプ(トピックタイプ)が用意されています。
【汎用topic情報タイプ】
DITAの出発点となる情報タイプで、HTMLライクな要素が定義されています。この情報タイプを使えばだいたいどのようなマニュアルも記述できますが、先ほど述べたように情報の質という点では劣ります。
昨日までにいくつかのトピックサンプルを例示しましたが、すべてこの情報タイプで記述したものです。
【task情報タイプ】
操作手順を記述するのに特化した情報タイプです。どのような順番でどういう操作をすればどのような結果が得られるか、というようなことを記述しやすいようになっています。
この情報タイプは上記の汎用topic情報タイプから派生させた(特殊化した)ものです。
【concept情報タイプ】
「それは何か」に対する答えを記述するのに便利な情報タイプです。たとえば「製品の特徴」であるとか「ご使用の前に」とか…etc。上記のtask情報タイプでは記述できないコンテンツは大抵この情報タイプを使うことになるでしょう。
この情報タイプは上記の汎用topic情報タイプから派生させた(特殊化した)ものです。
【reference情報タイプ】
リファレンスマニュアルを記述するのに特化した情報タイプです。
この情報タイプは上記の汎用topic情報タイプから派生させた(特殊化した)ものです。
【glossary情報タイプ】
用語集を記述するのに特化した情報タイプです。
この情報タイプは上記のconcept情報タイプから派生させた(特殊化した)ものです。
おおよそこれらのすでに用意された情報タイプで事足りると思いますが、中にはそれでも不十分だということもあるでしょう。そのときは(上記の情報タイプから派生させる形で)自分で特殊化することになります。
今日の話を図式化すると次のようになります。

なんだか、いかにもダーウィンって感じですね。
特殊化については(それだけで数十ページ書けそうな話題なので)これ以上突っ込んだ話は他の参考書に任せますが、日本語の参考書としては
DITA 101
DITA概説書
があります。
では、また明日。