DITAに関する情報源 DITAは誰もが無償で自由に利用できるグローバルスタンダードです。 DITAを採用することで、世界中のDITAユーザーと経験と、ノウハウを共有できるのです。 日本では非営利団体であるDITAコンソーシアムジャパンが研究と啓蒙、普及を推進しています。 DITAコンソーシアムジャパン http://www.dita-jp.org DITAコンソーシアムジャパンは、企業を超えた DITA の研究調査やセミナー、イベント等の公的活動を通して日本における DITA 啓蒙、普及を 推進するオープンな非営利団体です。DITAコンソーシアムジャパンサイトではDITAに関する資料やセミナー情報が公開されています。 DITAコンソーシアムジャパン 会員SNSサイト 会 員 限 定 書 籍 DITAコンソーシアムジャパン会員有志が翻訳した書籍 専門部会で作成した資料や海外セミナーの 発表資料などを掲載しています。 DITA概説書 DITAを使ったドキュメント作成業務に携わる方や、DITA関連の仕事をさ DITAの全体像を理解するのに役に立つ内容です。 れる方が、 DITA 101 Version2 執筆者と管理者のためのDITAの基礎 これからDITAを導入しようとする管理者や執筆者に対して、DITAの導入 メリットや導入準備をやさしく説明しています。 DITAの実践 [第2版] ディタ DITAでどのように書くか、どうすれば希望どおりの出力が得られるかな タイムトゥマーケットを加速する どを説明しています。執筆の際に行わなければならない選択や決定を考 察し、執筆者が考慮すべきアーキテクチャーについても言及しています。 セミナー 海外では、CIDM社が主催する「Content Management Strategies/DITA」セミナーが、北米と欧州で毎年各1回行われています。 DITAコンソーシアムジャパンは、毎回会員を派遣し聴講内容を国内にフィードバックしています。 国内では、DITAコンソーシアムジャパン主催のDITA総合セミナー「DITA Festa」が毎年2回開催されています。 国内ユーザー事例を中心に導入ノウハウを共有できます。 グローバルスタンダード Darwin Information Typing Architecture DITAユーザ交流会 DITA導入に係わる実践ノウハウを共有するための日本ユーザー企業による研究組織です。 DITAコンソーシアムジャパンが活動をサポートしています。DITAに関心のあるユーザー企業であれば、無償で参加が可能です。 OASIS https://www.oasis-open.org/ OASIS（オアシス）とは、グローバルな情報社会のオープン標準の開発、統合および採用を推進する非営利国際コンソーシアムです。W3C と並んで、WEBや電子商取引、XML、文書フォーマット等に関わる標準化団体として、国際的に極めて有力な存在といえます。OASISサイトから DITAの規格の原典となる資料をダウンロードできます。 YAHOO! DITA users group http://tech.groups.yahoo.com/group/dita-users/ DITAのワールドワイドなユーザーコミュニティサイトです。世界中のDITAユーザーのノウハウが集約されています。 DITAコンソーシアムジャパン概要 名 称 DITAコンソーシアムジャパン 公開サイト http://www.dita-jp.org 英文名称 DITA Consortium Japan 事務局 アートダーウィン合同会社内 設 立 2009年2月4日 関係団体 DITAユーザ交流会 理事長 四分一 瑞紀（日本アイ・ビー・エム株式会社 理事） 問合せ [email protected] 理事会員※ 日本アイ･ビー･エム、アンテナハウス、富士ゼロックス、アートダーウィン 一般会員※ SDLジャパン デジタルコミュニケーションズ 丸星 ネクストソリューション YAMAGATA INTECH イデア・インスティテュート 横河電機 クォークジャパン 日立テクニカルコミュニケーションズ 大興 ナビックス NECデザイン&プロモーション クレステック アラヤ ヒューマンサイエンス PFUソフトウェア Welocalize Japan アヴァシス インフォグリーン サン・フレア インフォパース アイ・ディー・エー Magillem Design Services 中央図研 情報システムエンジニアリング ※会員社名は、株式会社等の表記を省略しています。一般会員は入会順に記載しています。 このカタログの情報は2013年2月1日現在のものです。内容は事前の予告なしに変更する場合があります。 本紙中のケーススタディは想定にもとづくものであり、すべてのお客様について同様の効果を実現することを 保証するものではありません。 DITA Consortiumのロゴは、DITAコンソーシアムジャパンの商標です。 他の会社名、製品名およびサービス名等は、各社の商標である場合があります。 © Copyright DITA Consortium Japan 2013 All Rights Reserved. DITAコンソーシアムジャパン DITA を 導入すべき症状と効果 海外展開と 市場投入の リードタイムを 短縮したい DITA はコンテンツをモジュール化し、さらに構造化、標準化することで、 製品の世界同時リリースが求められているが、マニュアルの多言語化に時間がかかる 事業の比重が海外に移り、ユーザーや執筆者も外国人になってきているのに、 いまだに日本人向けの仕様でいいと思っている ドキュメント規模が大きくなり、ワードの限界にきている 制作工程を短縮したいが、その方法が分からない 海外拠点でのマニュアル制作では、DTPの名人はいないし、これまでのように ツーカーで通じる制作会社もない 企業の経営資源は言うまでもなく、人、物、金、情報です。 情報の中でも、文書的な情報はコンテンツと呼ばれます。 問題点 マニュアルの納期遅れが、製品の市場投入の足かせになっている 解決策 ドキュメントを真の経営資源にするための国際規格です。 制作業務にグローバルスタンダードを採用 ドキュメントの制作は、多くの企業で属人的手工業の状態。 いまだに、人まかせ、協力会社まかせの、無法地帯です。 DITAの規格は無償で公開されており、世界各国の企業や機関で利用されています。海外拠点とともに新たな 制作の仕組みを構築するにあたって、 DITAは即効性、実効性の高い方式、ノウハウを提供してくれます。 これまで人まかせにしていたドキュメントの制作管理を、 徹底した部分改訂による制作工期の圧縮 DITA によって合理的かつシステマチックに行うことが可能になります。 DITAではトピック単位でコンテンツの作成、改訂、翻訳、レビューを進められます。マニュアル改訂の際に このチャレンジには、制作方式やプロセス、そして組織の変革が含まれます。 は、修正が必要なトピックだけを編集あるいは翻訳して、あとは自動組版によって出力するだけです。 その結果として、次のような経営的要求が叶えられるのです。 部門間の情報流通の迅速化 制作コストを 削減したい 問題点 制作、翻訳コストを削減する方法が分からない マニュアルの制作費がIT投資に匹敵する巨額になっている グローバル展開のための翻訳コストがうなぎ上りに増えている 改訂の度に、初版と同様の制作、翻訳費用がかかっている マニュアル制作のリードタイム短縮は、制作部門だけの努力では実現しません。 そのコンテンツの元となる企画、設計部門からの情報を効率的に受け渡し、再利用する環境が求められてい ます。そのためにDITAを組織横断的な情報マスターに位置付けてください。部門間の情報伝達を各部門で作 る文書のバケツリレーで行うのではなく、情報粒度の小さいトピックによってコンカレントに行います。 これにより情報伝達のオーバーヘッドを削減し、組織全体のパフォーマンスが向上します。 コンテンツのサプライチェーン OEM 先に製品を提供するだけでなく、DITA 形式のドキュメントコンテンツも提供します。これにより、 OEM側でのマニュアルのリライトは不要になります。必要なトピックを自社のマニュアルのマップに組み 込むだけでマニュアルが完成するので、OEM製品の市場投入のスピードアップに貢献できます。 印刷費がかさむ ドキュメント制作という業務が聖域となり、コスト構造が見えない 解決策 DTPをしないことによるコストの削減 これまでのドキュメント制作は、DTPソフトによって紙面を手作りするものでした。したがって、制作コストは頁数に比 例します。一方、DITAでは、スタイルシートを使って機械的にドキュメントを生成するため、DTPは不要です。日本語から 英語のドキュメントを作る場合、DITAでは、コンテンツを翻訳し、日本語版で使ったものと同じスタイルシートを適用し て、英語版を自動的に生成できます。 印刷しないことによるコストの削減 DITAでは、1つのコンテンツを印刷用のPDFだけでなく、HTMLやHelp、EPUBといった電子メディア形式に出力できま す。これにより、印刷費や配送コストを低減できます。同時にユーザーの利用形態に即した多様なデバイスでの提供が可 能になります。 コンテンツの再利用によるコストの削減 DITAは一度作ったコンテンツを部品のように再利用する仕組みを持っています。ドキュメントの新規制作あるいは改訂 の際に、既存のコンテンツを再利用することで制作コストを抑えられます。 制作業務の定量化による適正コストの算出 1 マニュアルの 品質と使い勝手を 向上したい 問題点 「必要な情報がどこに書いてあるのか分からない」、 「レイアウトや記載 内容に統一感がない」といったマニュアルへの苦情が後をたたない 執筆者によって品質のバラつきがある 用語が不統一で読者を惑わせ、欲しい情報がどこにあるのか分からない 解決策 読者目線のマニュアルへ DITAにより、読者の目的を意識し、それに応える記載と構成が可能になります。情報をタスク、コンセプト、 リファレンスといった情報タイプに書き分けることにより、必要な情報をすばやく簡単に見つけられるよ うな、使いやすいマニュアルを作ることができます。 DITAの情報構造による統制 DITAでは情報の内容に応じた書き方のルールがあります。このルールに従うことにより、ベテランであって も初心者であっても一定品質のコンテンツを制作できます。 DITAを導入することで、ドキュメントを工業製品のように生産できます。つまり、制作プロセスを客観化、定量化できる システマチックな用語、表現の統制 のです。例えば、改訂の際に、変更箇所の比率をシステムでチェックして、適正な見積もりを想定することが可能になり ます。 正することで、すべてのドキュメントの改修を自動的に行うことができます。 DITAでは、複数のドキュメントで共通に使用する情報を変数化できます。変数を定義しているマスターを修 2 DITA を 導入すべき症状と効果 海外展開と 市場投入の リードタイムを 短縮したい DITA はコンテンツをモジュール化し、さらに構造化、標準化することで、 製品の世界同時リリースが求められているが、マニュアルの多言語化に時間がかかる 事業の比重が海外に移り、ユーザーや執筆者も外国人になってきているのに、 いまだに日本人向けの仕様でいいと思っている ドキュメント規模が大きくなり、ワードの限界にきている 制作工程を短縮したいが、その方法が分からない 海外拠点でのマニュアル制作では、DTPの名人はいないし、これまでのように ツーカーで通じる制作会社もない 企業の経営資源は言うまでもなく、人、物、金、情報です。 情報の中でも、文書的な情報はコンテンツと呼ばれます。 問題点 マニュアルの納期遅れが、製品の市場投入の足かせになっている 解決策 ドキュメントを真の経営資源にするための国際規格です。 制作業務にグローバルスタンダードを採用 ドキュメントの制作は、多くの企業で属人的手工業の状態。 いまだに、人まかせ、協力会社まかせの、無法地帯です。 DITAの規格は無償で公開されており、世界各国の企業や機関で利用されています。海外拠点とともに新たな 制作の仕組みを構築するにあたって、 DITAは即効性、実効性の高い方式、ノウハウを提供してくれます。 これまで人まかせにしていたドキュメントの制作管理を、 徹底した部分改訂による制作工期の圧縮 DITA によって合理的かつシステマチックに行うことが可能になります。 DITAではトピック単位でコンテンツの作成、改訂、翻訳、レビューを進められます。マニュアル改訂の際に このチャレンジには、制作方式やプロセス、そして組織の変革が含まれます。 は、修正が必要なトピックだけを編集あるいは翻訳して、あとは自動組版によって出力するだけです。 その結果として、次のような経営的要求が叶えられるのです。 部門間の情報流通の迅速化 制作コストを 削減したい 問題点 制作、翻訳コストを削減する方法が分からない マニュアルの制作費がIT投資に匹敵する巨額になっている グローバル展開のための翻訳コストがうなぎ上りに増えている 改訂の度に、初版と同様の制作、翻訳費用がかかっている マニュアル制作のリードタイム短縮は、制作部門だけの努力では実現しません。 そのコンテンツの元となる企画、設計部門からの情報を効率的に受け渡し、再利用する環境が求められてい ます。そのためにDITAを組織横断的な情報マスターに位置付けてください。部門間の情報伝達を各部門で作 る文書のバケツリレーで行うのではなく、情報粒度の小さいトピックによってコンカレントに行います。 これにより情報伝達のオーバーヘッドを削減し、組織全体のパフォーマンスが向上します。 コンテンツのサプライチェーン OEM 先に製品を提供するだけでなく、DITA 形式のドキュメントコンテンツも提供します。これにより、 OEM側でのマニュアルのリライトは不要になります。必要なトピックを自社のマニュアルのマップに組み 込むだけでマニュアルが完成するので、OEM製品の市場投入のスピードアップに貢献できます。 印刷費がかさむ ドキュメント制作という業務が聖域となり、コスト構造が見えない 解決策 DTPをしないことによるコストの削減 これまでのドキュメント制作は、DTPソフトによって紙面を手作りするものでした。したがって、制作コストは頁数に比 例します。一方、DITAでは、スタイルシートを使って機械的にドキュメントを生成するため、DTPは不要です。日本語から 英語のドキュメントを作る場合、DITAでは、コンテンツを翻訳し、日本語版で使ったものと同じスタイルシートを適用し て、英語版を自動的に生成できます。 印刷しないことによるコストの削減 DITAでは、1つのコンテンツを印刷用のPDFだけでなく、HTMLやHelp、EPUBといった電子メディア形式に出力できま す。これにより、印刷費や配送コストを低減できます。同時にユーザーの利用形態に即した多様なデバイスでの提供が可 能になります。 コンテンツの再利用によるコストの削減 DITAは一度作ったコンテンツを部品のように再利用する仕組みを持っています。ドキュメントの新規制作あるいは改訂 の際に、既存のコンテンツを再利用することで制作コストを抑えられます。 制作業務の定量化による適正コストの算出 1 マニュアルの 品質と使い勝手を 向上したい 問題点 「必要な情報がどこに書いてあるのか分からない」、 「レイアウトや記載 内容に統一感がない」といったマニュアルへの苦情が後をたたない 執筆者によって品質のバラつきがある 用語が不統一で読者を惑わせ、欲しい情報がどこにあるのか分からない 解決策 読者目線のマニュアルへ DITAにより、読者の目的を意識し、それに応える記載と構成が可能になります。情報をタスク、コンセプト、 リファレンスといった情報タイプに書き分けることにより、必要な情報をすばやく簡単に見つけられるよ うな、使いやすいマニュアルを作ることができます。 DITAの情報構造による統制 DITAでは情報の内容に応じた書き方のルールがあります。このルールに従うことにより、ベテランであって も初心者であっても一定品質のコンテンツを制作できます。 DITAを導入することで、ドキュメントを工業製品のように生産できます。つまり、制作プロセスを客観化、定量化できる システマチックな用語、表現の統制 のです。例えば、改訂の際に、変更箇所の比率をシステムでチェックして、適正な見積もりを想定することが可能になり ます。 正することで、すべてのドキュメントの改修を自動的に行うことができます。 DITAでは、複数のドキュメントで共通に使用する情報を変数化できます。変数を定義しているマスターを修 2 詳細を見てみましょう ! DITA導入効果 日本語PDFの作成 ここでは、あるコンピューター・メーカーがDITAを導入した架空のケースをベースに 具体的な効果を考えてみましょう。 時間 98% % 100 導入後 80 ケース コスト 49% 60 このコンピューター・メーカーは、ソフトウェア製品を開発しています。 “製品A”は長い期間、年に1度のペースで改訂を重ねている主力製品で、Windows用、Unix用、Mac 用の3つのプラットフォームをサポートしています。 製品のマニュアルは、プラットフォームごとに「ご使用の手引き」と「リファレンス・ガイド」の2冊 を提供していて、Microsoft Wordを使用して作成しています。また、製品のグローバル化に伴い、 英語、繁体字中国語（Traditional Chinese）、簡体字中国語（Simplified Chinese）、韓国語の4か国語 の翻訳版も提供しています。 このケースでは、次のような改訂が行われたことを前提にしています。 根拠となる時間、単価、計算式については、http://dita-jp.org/?p=1279 をご覧ください。 マニュアルのページ数 マニュアルの改訂率 改訂の内訳 導入前 導入前 40 20 導入後 0 時間 コスト 品質 同じ修正を複数個所に対して行うことによる、修正漏 れや修正内容の不統一も防げます。また、機械的に処 理することにより、人的ミスによる不備が発生しなく なり、統一感のある安定した品質を確保できます。 ご使用の手引き： 200ページ リファレンス・ガイド： 300ページ 翻 訳 導入前 導入後 6 冊共通の内容： 60% 80 プラットフォーム間で共通の内容： 30% 固有の内容： 10% 時間 60 コスト 35% 40 情報はコンポーネント化して、一元管理されているため、複数マ ニュアル間で共通の修正は1箇所で行うことができます。DITA ファイル上で修正を行った後は、変換処理のプログラムを実行 すれば、 タグに応じたレイアウトに自動組版されます。 人が1ペー ジ1ページ行っていたレイアウト調整作業は不要になります。 導入前 % 100 20% 改訂に伴う修正には、6冊共通の修正、プラットフォーム間で共 通の修正、各マニュアルに固有の修正がありますが、同じ内容 の修正も、すべてのマニュアルに対して行います。 また、各ページのレイアウトは、1ページ1ページ人が行います。 35% 差分のみを対象として翻訳していきますが、 それぞれのマニュア ルの差分には、6冊共通の差分、プラットフォーム間で共通の差 分、各マニュアルに固有の差分、などが入り乱れている状態で す。 翻訳メモリーを適切にハンドリングして共通箇所については 重複して翻訳しないようにするのが理想ですが、期間や環境の 制限により実現できず、6冊を並行して別々に翻訳しています。 20 0 日本語版ファイルの修正から翻訳版PDFの作成までにかかる 期間とコストの差はどうなるでしょうか？ 100 時間 導入後 コスト 品質 同じ内容を並行して翻訳することによって発生する 訳文の揺らぎがなくなり、翻訳品質が向上します。 % 翻訳後のPDF作成 % 100 導入前 導入前 80 導入後 80 翻訳によって文字列の長さが変わるので、すべての言語のすべ てのページに対してレイアウト処理を行います。 60 60 40 20 40 コスト 時間 16 % 28% 0 3 時間 コスト 2% コスト 品質 導入後 時 間 時間 4% 20 導入前 0 情報はコンポーネント化して、一元管理されているため、複数マ ニュアル間で共通の差分は1箇所に集約されています。これによ り、共通の差分を重複して翻訳することがなくなります。 機械的に処理することにより、人的ミスによる不備 が発生しなくなり、統一感のある安定した品質を確 保できます。 導入後 変換処理のプログラムが、タグに応じたレイアウトに自動組版 してくれます。翻訳後のレイアウト調整作業は不要になります。 さらに．．． DITAではシングルソースからPDF、HTML、その他の様々なデ バイス用の出力を一度に作成できます。 コスト 4 詳細を見てみましょう ! DITA導入効果 日本語PDFの作成 ここでは、あるコンピューター・メーカーがDITAを導入した架空のケースをベースに 具体的な効果を考えてみましょう。 時間 98% % 100 導入後 80 ケース コスト 49% 60 このコンピューター・メーカーは、ソフトウェア製品を開発しています。 “製品A”は長い期間、年に1度のペースで改訂を重ねている主力製品で、Windows用、Unix用、Mac 用の3つのプラットフォームをサポートしています。 製品のマニュアルは、プラットフォームごとに「ご使用の手引き」と「リファレンス・ガイド」の2冊 を提供していて、Microsoft Wordを使用して作成しています。また、製品のグローバル化に伴い、 英語、繁体字中国語（Traditional Chinese）、簡体字中国語（Simplified Chinese）、韓国語の4か国語 の翻訳版も提供しています。 このケースでは、次のような改訂が行われたことを前提にしています。 根拠となる時間、単価、計算式については、http://dita-jp.org/?p=1279 をご覧ください。 マニュアルのページ数 マニュアルの改訂率 改訂の内訳 導入前 導入前 40 20 導入後 0 時間 コスト 品質 同じ修正を複数個所に対して行うことによる、修正漏 れや修正内容の不統一も防げます。また、機械的に処 理することにより、人的ミスによる不備が発生しなく なり、統一感のある安定した品質を確保できます。 ご使用の手引き： 200ページ リファレンス・ガイド： 300ページ 翻 訳 導入前 導入後 6 冊共通の内容： 60% 80 プラットフォーム間で共通の内容： 30% 固有の内容： 10% 時間 60 コスト 35% 40 情報はコンポーネント化して、一元管理されているため、複数マ ニュアル間で共通の修正は1箇所で行うことができます。DITA ファイル上で修正を行った後は、変換処理のプログラムを実行 すれば、 タグに応じたレイアウトに自動組版されます。 人が1ペー ジ1ページ行っていたレイアウト調整作業は不要になります。 導入前 % 100 20% 改訂に伴う修正には、6冊共通の修正、プラットフォーム間で共 通の修正、各マニュアルに固有の修正がありますが、同じ内容 の修正も、すべてのマニュアルに対して行います。 また、各ページのレイアウトは、1ページ1ページ人が行います。 35% 差分のみを対象として翻訳していきますが、 それぞれのマニュア ルの差分には、6冊共通の差分、プラットフォーム間で共通の差 分、各マニュアルに固有の差分、などが入り乱れている状態で す。 翻訳メモリーを適切にハンドリングして共通箇所については 重複して翻訳しないようにするのが理想ですが、期間や環境の 制限により実現できず、6冊を並行して別々に翻訳しています。 20 0 日本語版ファイルの修正から翻訳版PDFの作成までにかかる 期間とコストの差はどうなるでしょうか？ 100 時間 導入後 コスト 品質 同じ内容を並行して翻訳することによって発生する 訳文の揺らぎがなくなり、翻訳品質が向上します。 % 翻訳後のPDF作成 % 100 導入前 導入前 80 導入後 80 翻訳によって文字列の長さが変わるので、すべての言語のすべ てのページに対してレイアウト処理を行います。 60 60 40 20 40 コスト 時間 16 % 28% 0 3 時間 コスト 2% コスト 品質 導入後 時 間 時間 4% 20 導入前 0 情報はコンポーネント化して、一元管理されているため、複数マ ニュアル間で共通の差分は1箇所に集約されています。これによ り、共通の差分を重複して翻訳することがなくなります。 機械的に処理することにより、人的ミスによる不備 が発生しなくなり、統一感のある安定した品質を確 保できます。 導入後 変換処理のプログラムが、タグに応じたレイアウトに自動組版 してくれます。翻訳後のレイアウト調整作業は不要になります。 さらに．．． DITAではシングルソースからPDF、HTML、その他の様々なデ バイス用の出力を一度に作成できます。 コスト 4 トピックタイプとは DITAとは Darwin Information Typing Architecture DITAは、ドキュメントの執筆から出力物の生成までを網羅した、 ドキュメント制作方法論のグローバルスタンダードであり、 誰もが自由に利用できます。 国際的な標準化団体であるOASIS（構造化情報標準促進協会）が、 DITAの規格を管理しており、2005年のDITA1.0からバージョンアップを重ねて 現在DITA1.2が規格化され、さらなる発展のためにDITA1.3の仕様が検討中です。 DITAは、文書作成の効率化に加えて、情報伝達の効率化も実現する画期的な規格です。 DITAの規格では、伝える情報の種類に応じて、情報の構造（情報タイプ）を定義しています。 情報タイプは拡張が可能で、特定分野の情報伝達に最適化された 情報タイプを定義できます。 新たな情報タイプを定義するとき、特殊化と呼ばれる継承の概念を持った仕組みを 使います。特殊化を使って新しい情報タイプを作成すると、 編集環境やパブリッシング環境をそのまま使い続けられます。 この「進化する情報タイプ」が、Darwin Information Typingの名前の由来です。 マップとは DITAでは、情報の種類に応じて定められた情報タイプのことを 「トピックタイプ」と呼びます。タスク、コンセプト、リファレン スという3つのタイプがあり、これらが基本のトピックタイプで す。これらのトピックタイプは、テクニカルライティングのベス トプラクティスを取り入れています。例えば、操作手順を説明す るタスクトピックでは、 「ユーザーが行う操作」と「操作の結果」 を明確に書き分けられるようルール化されています。すべての 操作手順が同じルールで書かれるため、ユーザーは自分が行う べき操作を、素早くかつ誤りなく読み取れます。 ∼とは 概念・機能の説明 マップは、トピック間の関係を定義し、出力物の構成を決めるた めの文書です。マップを使って、階層構造では表せない任意のト ピック間の関係を定義することも可能です。マップは、情報のコ ンテンツを表すトピックから独立しています。複数のマップを 作成することにより、同一のトピック群から、目的の異なる複数 のマニュアルを生成できます。例えば、同一のトピック群から、 オーナーズ・マニュアルと、クイック・リファレンス・マニュアル を生成するといったことが可能です。 オーナーズ・ マニュアル ∼するには マップ1 ●●エラー が出たら 手順の説明 マップ2 情報の種類に 応じて整理 辞書的な詳細説明 情報の構造の標準化 コンセプト トピック タスク トピック リファレンス トピック トピックタイプ DITAによるドキュメント制作方式 DITAによるドキュメント制作方式について、制作プロセスと制作環境に分けて説明します。 ブック指向から トピック指向へ トピック指向のメリット ブック指向の問題 ブック指向のマニュアルは、 「必要な情報はマニュアルのどこ か に 書 か れ て い て 、ユ ー ザ ー は マニュアルの最初から最後まで 読む」という前提のもとに作成さ れています。一方、読者は目的を 達成するために必要な情報だけ を、素早く手に入れたいと願って お り 、ブ ッ ク 指 向 と ユ ー ザ ー の ニーズとの間にはギャップがあ ります。 トピック指向では、 「∼とは？」、 「∼するにはどうすればよいのか？」、 「このエラーの原因は？」といっ た問いに、それぞれのトピックが直接答えます。必要な情報をより簡単に発見できるよう、トピックの 並び、階層、関連を検討し、トピックを組み合わせて文書を作成します。トピック指向で書かれた文書 は、紙マニュアルにもオンライン・ヘルプにもなり、ユーザー指向での情報提供が可能になります。 ブック指向 トピック指向 先頭から順に読み進める 必要な情報を選択して読む トピック執筆 出 力 ドキュメント読者のニーズを分析し、タスクフローを軸 にマップを設計します。タスク実行に必要な基礎知識は コンセプトトピック、タスク実行時に参照する詳細情報 はリファレンストピックとして配置します。 マップの設計に従って各トピッ クを 執 筆 し ま す 。ト ピ ッ ク は 独 立しているため、複数の執筆者 が コンカレントにトピックを執 筆できます。 出力システムとスタイルシート を使って、マップとトピックを目 的の形式に変換します。 ● ● エンドユーザーの要求分析のスキル 製品体系の知識 使用するタグの規約など、制作ガイドラインを 作成するスキル DITA Open Toolkitなどの 出力ツールに関する知識 トピック指向ライティング スタイル作成 特殊化対応 成果物（PDF、HTMLなど）のレイアウトデザイン（行間、ヘッ ダ／フッタ、フォントなど）を決定する、スタイルシートを作 成します。 特定種類の情報を書くために、より厳格な執筆ルールが必要 な場合は、標準のトピックタイプやタグセットをその情報に 合わせて最適化します。 XSL、XSL-FO、CSS等に関する知識 ● ● ● 最初にお読みください DTDあるいはXML Schemaの知識 XMLの仕様に関する知識 DITA言語仕様に関する知識 各部の名称 オーサリングツール ○○○の特徴 ○○○の操作 ○○○の仕様 トピックとは トピックとは、 1つの目的を達成するために必要十分な情報を提供する、タイトルと本文から成る情報の単位です。 各トピックは独立しており、トピックが配置されるコンテクストに依存することなく、ユーザーにとって役に立つ、ひとまとまりの情 報を提供します。DITAによるマニュアル制作では、 トピックが編集と再利用の基本単位になります。 通常、 1つのトピックが1つのファイ ルになります。 制作環境 故障かなと思ったら 5 ※ は、必要な知識とスキルです。 情報設計／マップ作成 ● 制作プロセス インターネットの普及により、情報をオンラインで取得することがあたり前のようになっています。そのような状況の中で、まと まりのよい、簡潔かつ正確な情報提供のニーズが高まりつつあります。トピック指向は、このニーズに応える情報発信の方法論で、 DITA のライティング・アーキテクチャの根幹になっています。ブック指向のマニュアルとは、印刷・製本されることを前提に作ら れた、章・節・項の構造を持つマニュアルのことです。一方、トピック指向のマニュアルとは、独立した情報モジュールの組み合わせ によって作られたマニュアルのことです。 クイック リファレンス トピック群 マップとトピックを執筆するためのツールです。 独立したアプリケーション、あるいはWebアプリ ケーションのオーサリングツールがあります。 DITAをサポートしている最新のXMLエディタを 用いると、タグを意識せずにワードと同様の操作 で原稿を執筆できます。 出力システム マップとトピックから成果物を生成するためのソフトウェアです。出力システムとし て、DITA Open Toolkit と呼ばれるオープンソースのソフトウェアが利用可能です。 DITA Open Toolkitは、標準でPDF、XHTML、HTML Help、JavaHelpなどの出力形式を サポートしています。成果物として、よりきめ細かな表現のPDFが必要な場合は、商用 のFOフォーマッター（XSL-FOをPDFに変換するソフトウェア）を別途用意する必要が あります。 コンテンツ管理システム トピック、マップ、グラフィックス、出力物等を管理するソフトウェアです。DITAコンテンツの再利用を目的にしたコンテンツ管理システム は、 CCMS（Component Content Management System）と呼ばれます。下記のようなドキュメント制作を行う場合、CCMSの導入が必要 になります。 複数の執筆者、校正者、 翻訳者が同時並行で作業する 複数のドキュメント間で コンテンツを再利用する 複数バージョンのドキュメントを、 同時並行で制作する 6 トピックタイプとは DITAとは Darwin Information Typing Architecture DITAは、ドキュメントの執筆から出力物の生成までを網羅した、 ドキュメント制作方法論のグローバルスタンダードであり、 誰もが自由に利用できます。 国際的な標準化団体であるOASIS（構造化情報標準促進協会）が、 DITAの規格を管理しており、2005年のDITA1.0からバージョンアップを重ねて 現在DITA1.2が規格化され、さらなる発展のためにDITA1.3の仕様が検討中です。 DITAは、文書作成の効率化に加えて、情報伝達の効率化も実現する画期的な規格です。 DITAの規格では、伝える情報の種類に応じて、情報の構造（情報タイプ）を定義しています。 情報タイプは拡張が可能で、特定分野の情報伝達に最適化された 情報タイプを定義できます。 新たな情報タイプを定義するとき、特殊化と呼ばれる継承の概念を持った仕組みを 使います。特殊化を使って新しい情報タイプを作成すると、 編集環境やパブリッシング環境をそのまま使い続けられます。 この「進化する情報タイプ」が、Darwin Information Typingの名前の由来です。 マップとは DITAでは、情報の種類に応じて定められた情報タイプのことを 「トピックタイプ」と呼びます。タスク、コンセプト、リファレン スという3つのタイプがあり、これらが基本のトピックタイプで す。これらのトピックタイプは、テクニカルライティングのベス トプラクティスを取り入れています。例えば、操作手順を説明す るタスクトピックでは、 「ユーザーが行う操作」と「操作の結果」 を明確に書き分けられるようルール化されています。すべての 操作手順が同じルールで書かれるため、ユーザーは自分が行う べき操作を、素早くかつ誤りなく読み取れます。 ∼とは 概念・機能の説明 マップは、トピック間の関係を定義し、出力物の構成を決めるた めの文書です。マップを使って、階層構造では表せない任意のト ピック間の関係を定義することも可能です。マップは、情報のコ ンテンツを表すトピックから独立しています。複数のマップを 作成することにより、同一のトピック群から、目的の異なる複数 のマニュアルを生成できます。例えば、同一のトピック群から、 オーナーズ・マニュアルと、クイック・リファレンス・マニュアル を生成するといったことが可能です。 オーナーズ・ マニュアル ∼するには マップ1 ●●エラー が出たら 手順の説明 マップ2 情報の種類に 応じて整理 辞書的な詳細説明 情報の構造の標準化 コンセプト トピック タスク トピック リファレンス トピック トピックタイプ DITAによるドキュメント制作方式 DITAによるドキュメント制作方式について、制作プロセスと制作環境に分けて説明します。 ブック指向から トピック指向へ トピック指向のメリット ブック指向の問題 ブック指向のマニュアルは、 「必要な情報はマニュアルのどこ か に 書 か れ て い て 、ユ ー ザ ー は マニュアルの最初から最後まで 読む」という前提のもとに作成さ れています。一方、読者は目的を 達成するために必要な情報だけ を、素早く手に入れたいと願って お り 、ブ ッ ク 指 向 と ユ ー ザ ー の ニーズとの間にはギャップがあ ります。 トピック指向では、 「∼とは？」、 「∼するにはどうすればよいのか？」、 「このエラーの原因は？」といっ た問いに、それぞれのトピックが直接答えます。必要な情報をより簡単に発見できるよう、トピックの 並び、階層、関連を検討し、トピックを組み合わせて文書を作成します。トピック指向で書かれた文書 は、紙マニュアルにもオンライン・ヘルプにもなり、ユーザー指向での情報提供が可能になります。 ブック指向 トピック指向 先頭から順に読み進める 必要な情報を選択して読む トピック執筆 出 力 ドキュメント読者のニーズを分析し、タスクフローを軸 にマップを設計します。タスク実行に必要な基礎知識は コンセプトトピック、タスク実行時に参照する詳細情報 はリファレンストピックとして配置します。 マップの設計に従って各トピッ クを 執 筆 し ま す 。ト ピ ッ ク は 独 立しているため、複数の執筆者 が コンカレントにトピックを執 筆できます。 出力システムとスタイルシート を使って、マップとトピックを目 的の形式に変換します。 ● ● エンドユーザーの要求分析のスキル 製品体系の知識 使用するタグの規約など、制作ガイドラインを 作成するスキル DITA Open Toolkitなどの 出力ツールに関する知識 トピック指向ライティング スタイル作成 特殊化対応 成果物（PDF、HTMLなど）のレイアウトデザイン（行間、ヘッ ダ／フッタ、フォントなど）を決定する、スタイルシートを作 成します。 特定種類の情報を書くために、より厳格な執筆ルールが必要 な場合は、標準のトピックタイプやタグセットをその情報に 合わせて最適化します。 XSL、XSL-FO、CSS等に関する知識 ● ● ● 最初にお読みください DTDあるいはXML Schemaの知識 XMLの仕様に関する知識 DITA言語仕様に関する知識 各部の名称 オーサリングツール ○○○の特徴 ○○○の操作 ○○○の仕様 トピックとは トピックとは、 1つの目的を達成するために必要十分な情報を提供する、タイトルと本文から成る情報の単位です。 各トピックは独立しており、トピックが配置されるコンテクストに依存することなく、ユーザーにとって役に立つ、ひとまとまりの情 報を提供します。DITAによるマニュアル制作では、 トピックが編集と再利用の基本単位になります。 通常、 1つのトピックが1つのファイ ルになります。 制作環境 故障かなと思ったら 5 ※ は、必要な知識とスキルです。 情報設計／マップ作成 ● 制作プロセス インターネットの普及により、情報をオンラインで取得することがあたり前のようになっています。そのような状況の中で、まと まりのよい、簡潔かつ正確な情報提供のニーズが高まりつつあります。トピック指向は、このニーズに応える情報発信の方法論で、 DITA のライティング・アーキテクチャの根幹になっています。ブック指向のマニュアルとは、印刷・製本されることを前提に作ら れた、章・節・項の構造を持つマニュアルのことです。一方、トピック指向のマニュアルとは、独立した情報モジュールの組み合わせ によって作られたマニュアルのことです。 クイック リファレンス トピック群 マップとトピックを執筆するためのツールです。 独立したアプリケーション、あるいはWebアプリ ケーションのオーサリングツールがあります。 DITAをサポートしている最新のXMLエディタを 用いると、タグを意識せずにワードと同様の操作 で原稿を執筆できます。 出力システム マップとトピックから成果物を生成するためのソフトウェアです。出力システムとし て、DITA Open Toolkit と呼ばれるオープンソースのソフトウェアが利用可能です。 DITA Open Toolkitは、標準でPDF、XHTML、HTML Help、JavaHelpなどの出力形式を サポートしています。成果物として、よりきめ細かな表現のPDFが必要な場合は、商用 のFOフォーマッター（XSL-FOをPDFに変換するソフトウェア）を別途用意する必要が あります。 コンテンツ管理システム トピック、マップ、グラフィックス、出力物等を管理するソフトウェアです。DITAコンテンツの再利用を目的にしたコンテンツ管理システム は、 CCMS（Component Content Management System）と呼ばれます。下記のようなドキュメント制作を行う場合、CCMSの導入が必要 になります。 複数の執筆者、校正者、 翻訳者が同時並行で作業する 複数のドキュメント間で コンテンツを再利用する 複数バージョンのドキュメントを、 同時並行で制作する 6 DITAに関する情報源 DITAは誰もが無償で自由に利用できるグローバルスタンダードです。 DITAを採用することで、世界中のDITAユーザーと経験と、ノウハウを共有できるのです。 日本では非営利団体であるDITAコンソーシアムジャパンが研究と啓蒙、普及を推進しています。 DITAコンソーシアムジャパン http://www.dita-jp.org DITAコンソーシアムジャパンは、企業を超えた DITA の研究調査やセミナー、イベント等の公的活動を通して日本における DITA 啓蒙、普及を 推進するオープンな非営利団体です。DITAコンソーシアムジャパンサイトではDITAに関する資料やセミナー情報が公開されています。 DITAコンソーシアムジャパン 会員SNSサイト 会 員 限 定 書 籍 DITAコンソーシアムジャパン会員有志が翻訳した書籍 専門部会で作成した資料や海外セミナーの 発表資料などを掲載しています。 DITA概説書 DITAを使ったドキュメント作成業務に携わる方や、DITA関連の仕事をさ DITAの全体像を理解するのに役に立つ内容です。 れる方が、 DITA 101 Version2 執筆者と管理者のためのDITAの基礎 これからDITAを導入しようとする管理者や執筆者に対して、DITAの導入 メリットや導入準備をやさしく説明しています。 DITAの実践 [第2版] ディタ DITAでどのように書くか、どうすれば希望どおりの出力が得られるかな タイムトゥマーケットを加速する どを説明しています。執筆の際に行わなければならない選択や決定を考 察し、執筆者が考慮すべきアーキテクチャーについても言及しています。 セミナー 海外では、CIDM社が主催する「Content Management Strategies/DITA」セミナーが、北米と欧州で毎年各1回行われています。 DITAコンソーシアムジャパンは、毎回会員を派遣し聴講内容を国内にフィードバックしています。 国内では、DITAコンソーシアムジャパン主催のDITA総合セミナー「DITA Festa」が毎年2回開催されています。 国内ユーザー事例を中心に導入ノウハウを共有できます。 グローバルスタンダード Darwin Information Typing Architecture DITAユーザ交流会 DITA導入に係わる実践ノウハウを共有するための日本ユーザー企業による研究組織です。 DITAコンソーシアムジャパンが活動をサポートしています。DITAに関心のあるユーザー企業であれば、無償で参加が可能です。 OASIS https://www.oasis-open.org/ OASIS（オアシス）とは、グローバルな情報社会のオープン標準の開発、統合および採用を推進する非営利国際コンソーシアムです。W3C と並んで、WEBや電子商取引、XML、文書フォーマット等に関わる標準化団体として、国際的に極めて有力な存在といえます。OASISサイトから DITAの規格の原典となる資料をダウンロードできます。 YAHOO! DITA users group http://tech.groups.yahoo.com/group/dita-users/ DITAのワールドワイドなユーザーコミュニティサイトです。世界中のDITAユーザーのノウハウが集約されています。 DITAコンソーシアムジャパン概要 名 称 DITAコンソーシアムジャパン 公開サイト http://www.dita-jp.org 英文名称 DITA Consortium Japan 事務局 アートダーウィン合同会社内 設 立 2009年2月4日 関係団体 DITAユーザ交流会 理事長 四分一 瑞紀（日本アイ・ビー・エム株式会社 理事） 問合せ [email protected] 理事会員※ 日本アイ･ビー･エム、アンテナハウス、富士ゼロックス、アートダーウィン 一般会員※ SDLジャパン デジタルコミュニケーションズ 丸星 ネクストソリューション YAMAGATA INTECH イデア・インスティテュート 横河電機 クォークジャパン 日立テクニカルコミュニケーションズ 大興 ナビックス NECデザイン&プロモーション クレステック アラヤ ヒューマンサイエンス PFUソフトウェア Welocalize Japan アヴァシス インフォグリーン サン・フレア インフォパース アイ・ディー・エー Magillem Design Services 中央図研 情報システムエンジニアリング ※会員社名は、株式会社等の表記を省略しています。一般会員は入会順に記載しています。 このカタログの情報は2013年2月1日現在のものです。内容は事前の予告なしに変更する場合があります。 本紙中のケーススタディは想定にもとづくものであり、すべてのお客様について同様の効果を実現することを 保証するものではありません。 DITA Consortiumのロゴは、DITAコンソーシアムジャパンの商標です。 他の会社名、製品名およびサービス名等は、各社の商標である場合があります。 © Copyright DITA Consortium Japan 2013 All Rights Reserved. DITAコンソーシアムジャパン
© Copyright 2024 Paperzz
