DITAについて

Posted on

Posted on

DITAコンテンツを機械校閲するためのスキマトロン紹介

マニュアルの品質をキープするために、ライターに対して制作基準やライティング・ルールを遵守させ、指導していくことが恒常的、継続的に必要になります。しかしその指導を人的リソースだけに頼るのは現実的ではありません。

DITA 制作では、ISO/IEC 規格のスキマトロン(Schematron)によって、誤ったタグの使い方や改善すべき文章内容の指摘、矯正をツールで自動化できます。自社のライティング・ルールをスキマトロンに実装し、エディターに組み込むことで、編集中のライターに正しいライティングを指導することが可能、まさに制作の水際でコンテンツのクオリティを確保するわけです。

弊社ではDITAコンソーシアムジャパン主催「DITA Festa」でスキマトロンを紹介し、受講者アンケートで最高評価を得ました。この発表資料を以下から入手できます。スキマトロンの概要と効果、適用方法をてっとりばやく学ぶことができます。

資料はこちらから。

Posted on

CCMSの機能・運用要件のJIS規格「JIS X 0154」が公開されました(2018年4月10日)

コンポーネントコンテンツ管理(CCMS)に関わる日本工業規格「JIS X 0154」が日本規格協会より発行されました。正式には「システム及びソフトウェア技術-製品ライフサイクル、利用者及びサービスマネージンメントの文書化のためのコンテンツ管理」という長いタイトルを持った規格です。

弊社はこの規格の原案作成委員の一人として1年間にわたり策定に携わりました。コンポーネントコンテンツ管理という新しいカテゴリのJIS作成に参画できたことは大変光栄なことです。

この規格の和文冊子はこちらから購入できます。DITAのコンテンツ管理に求められるシステム要件を知りたい方や、CCMSの選定、導入、運用に関わる方には必読の一冊と言えます。

JIS-X0154

Posted on

品質と生産性を両立する「DITAダイナミックドキュメンテーション」

マニュアルはその企業の知的成果を集積した市場接点です。各部門からの知的成果が早く、正しくマニュアルに集積されることが企業の競争力につながります。しかしどの企業も部門間でのドキュメントのバケツリレー属人的なすり合わせでなんとか行っているのが現状です。この解決策として、DITAによるダイナミックドキュメンテーションの方法論を紹介しました。この内容はモノづくりスペシャリストのための情報ポータルMONOistの連載企画「製造業ドキュメンテーションの課題」に「バケツリレーによるマニュアルづくりから脱却するための手法とは」として公開されています。

記事全文はこちらから。

Dynamic-docu0

マニュアルは部門ナレッジを集積するジグソーパズル。このジクソーパズルを少しでも速く完成するには、各部門が同時並行で自分のピース(知的成果)をはめていくことが必要である。このコンカレント性こそが企業の競争力につながる。

Dynamic-docu

各部門の情報をDITA形式に変換してマニュアルに集積するダイナミック・ドキュメンテーション。これによってマニュアル制作に品質と生産性を両立させることが可能になる。

Posted on

XMLの本質とDITAによる情報デザインについて

2009年8月27日に開催された「DESIGN IT! Forum 2009」で当社代表、加藤哲義(当時、株式会社ジャストシステム)が講演した資料です。講演タイトルは、「松明は引き継がれるか? - DITAによる情報デザイン戦略 –」というもので、”コンテンツ”に対する考察、XML技術の本質、DITAの情報デザインを概説しています。多くの方に賞賛をいただきました。

資料はこちらから。

Posted on

ドキュメンテーションと業務システムの融合(XMetaLカスタマイズ例)

マニュアルなどの文書コンテンツを、DITAに代表されるXMLで記述する目的、メリットのなかで、意外に見落とされがちなのが、社内システムからのデータをドキュメントに統合できることです。

設計、生産管理、品質保証、販売業務といった社内システムのデータを、顧客接点であるマニュアルコンテンツに、動的かつシステマティックに流し込むことで、社内リソースを総動員し、顧客満足を勝ち得る企業ドキュメンテーションが実現します。

このメリットを享受するためには、DITAの編集環境をカスタマイズして、他システムと連携できるようにすることが必要です。

XMetaLは世界的に著名な、歴史あるXMLオーサリングツールです。XMLのスキーマに応じて最適な編集環境にカスタマイズしたり、外部システムと連携することができます。

以下は、マニュアルに記載すべき工具の情報を、XMetaLから工具情報データベースに問合せ、該当するデータをDITA化して編集中のドキュメントに挿入するカスタマイズ例です。ライターにとって、情報を探し出す手間を省き、同時に記載ミスを防ぐことができます。

XMetaLをカスタマイズすることで、このような編集環境を実現できます。

処理モデル

連携モデル

XMetaLからのシステム連携画面

レンチ1

選択した値からDITA要素が生成されXMetaLに挿入される

レンチ2

Posted on

DITAによる情報の構造化とは

情報の電子化とは、既存文書の電子化では無く、情報の性格と利用目的に応じて情報構造そのものを見直し、再構築するところから始まります。その手段として今注目を集めているのが DITA(Darwin Information Architecture) です。

DITA は XML が謳う情報デザインの理想をアーキテクチャとして具現したものといえます。すなわち情報を、制作や活用の目的、利便性に応じて任意の粒度でモジュール化(XML化)して、企業資産にする国際規格です。これは特に製品マニュアル、サービスマニュアル、業務マニュアル、仕様書のような流用性が高く、目的指向のコンテンツ制作で導入されてきています。

Posted on

製造業コンテンツ制作の新しいグローバル基準 ~DITAの紹介と導入法~ 講演資料と実況録画

Siemens PLM Connection Japan 2012 (2012年7月19日開催)で弊社代表が講演した資料を掲載しました。設計製造分野でのDITAの効能を解説していますが、DITA入門の資料として、速攻でDITAの全体像をつかむこともできると思います。

講演資料はこちらから

この講演の実況録画をYou Tubeで見ることができます。講演資料の解説と実演入りなので、リアルにDITAを理解し、その制作方式を実感できる、格好のDITA入門ビデオになっています。後半にはDITAエディタ(XMetaL)を使ったトピック指向によるカタログ制作の実演が盛り込まれていて、資料だけでは分からないDITA制作のプロセスを垣間見ることができると思います。

Posted on

製造業を取り巻く課題とDITAの意義

日経BP社「Tech-Oh!」へ投稿した記事です。
文書づくりはものづくりの一環であり、日本の製造業が置かれている昨今の状況は文書づくりにとっても他人事では無い。文書づくりの環境変化のなかでの、DITAの意義や役割をまとめています。

記事はこちらから

Posted on

DITAのトピックベースライティングは支援物資の梱包方式と同じ

DITA Festa2011(2011年6月22日)の「美味しいDITAとEPUBの作り方」で講演したのですが、topic制作のコツは、支援物資の梱包方法と以下の点で酷似しているのです。要は受け手(読者)の使い安さを考えて、内容をちゃんと仕分けした状態で荷詰め(制作)しようね、ということです。

鉄則 支援物資の梱包 トピックベースライティング 意義
同一種によるパッケージング 段ボール1箱には1種類の物資を詰める、あるいは箱内では同種のもので小分けする ・1topicには1テーマを記載する。
・1topic内ではsectionによる情報の再仕分けを行う
受け手が中身の仕分けをしなくてすむ
明快なラベリング 段ボール箱の表面に内容物のラベルを貼る ・具体的なtopic タイトル、sectionタイトルを付ける
・より細かな仕分けとラベリングには、表、dl(タイトル付リスト)を使う
・shortdescを記してタイトルを補足する
受け手にとって必要かどうかの判断を速やかにさせる
大きすぎないパッケージ 運びやすく場所をとらない段ボール箱を使う 1テーマを過不足なく説明することができる最小サイズのtopicを作る 小ぶりのほうが受け手にとって使い易い(理解しやすい)

Posted on

conref、conkeyref、keyref といった再利用の仕組みを使ったDITAサンプルコンテンツと解説資料

2012年3月27日に主催した「美味しいDITAの作り方セミナー(実践編)」では、当社代表、加藤哲義が「DITA1.2を活用したコンテンツ再利用の手法」の発表をしました。そこで使ったサンプルDITAコンテンツと解説書を掲載いたしました。

以下2つのzipファイルをダウンロードし、解凍して下さい。解説書(美味しいDITAの作り方セミナー_コンテンツ解説)は、「祭りコンテンツ_By_conref」を解凍した中にありますので最初にご参照下さい。

祭りコンテンツ_By_conref

祭りコンテンツ_By_conkeyref_keyref

関連ブログ(アンケート結果など)

Posted on

XMLDB、そのアナーキーな魅力

いうまでもなくDITAは、XMLの1ボキャブラリであり、XMLの特性やアドバンテージの上に成り立っています。DITAを理解するには、まずXMLを知ることが肝心です。XMLの特性をシステムとして発現したのが、ネイティブXMLデータベース(NXDB)というカテゴリの製品です。弊社代表は、1999年から日本で最初にNXDBを事業として推進してきました。以下は、XMLの拡がりや市場性、そしてXMLを導入しようとする企業人の個性をまとめた文章ですが、これからDITAにチャレンジする方の参考になると思います。(執筆当時に所属していた社名、役職になっています)

XMLDB、そのアナーキナーな魅力(1)
XMLDB、そのアナーキナーな魅力(2)
XMLDB、そのアナーキナーな魅力(3)