スキーマを記録する上位5つの理由
スキーマの開発は、多くの場合、反復的なプロセスであり、開発者は通常、最初からゼロから始めることはありません。XMLスキーマや、近年ますます重要になっているJSONスキーマは、既存のドキュメントを基に構築されたり、他のチームから継承されたりすることが一般的です。スキーマの構成要素間の関連性を理解し、開発における選択に関する情報を分析できることは非常に役立ちますが、効果的なドキュメントが不足しているため、それがしばしば困難です。
それでは、XSD、JSON、またはその他のスキーマ開発において、ドキュメントが不可欠な要素となる理由について、いくつか見ていきましょう。
XSDスキーマのドキュメント化の利点
次にスキーマを作成する際に、ドキュメント作成のステップを省略すべきではない、その主な理由を以下に示します。
1. 開発チームのメンバー間の円滑なコミュニケーションを可能にします。
スキーマの開発は、多くの場合、共同作業で行われます。明確で簡潔なドキュメントは、異なる開発者がスキーマやスキーマ群の異なる部分に取り組む際に、混乱を避け、生産性を向上させるのに役立ちます。また、明確なドキュメントは、複数の専門家がコンテンツモデルについて意見を交換できるピアレビューを促進します。
- 継承されたプロジェクトを迅速に理解し、活用することができます。
これは上記の点と密接に関連しています。買収された企業から引き継いだコードや、部署間の引き継ぎが行われたコードは、常にドキュメント化されている方が良いでしょう。たとえそのプロジェクトが自社で始まったとしても、当初の開発者がいなくなっているか、あるいは開発が細分化されていて、プロジェクト全体を把握している担当者がいない、ということもあり得ます。
もちろん、ほとんどのプロジェクトは単にスキーマだけで構成されているわけではありません。既存のコードを完全に分析するためには、プロジェクトを文書化し、視覚的に理解しやすくするために、UML図を生成することが役立ちます。
- インポートされた、または組み込まれたスキーマに関する情報を一元的に管理します。
多数の文書を一つ一つ確認して関係性を把握する代わりに、スキーマのドキュメントには、関連するすべての文書に関する情報を、単一の集中管理された場所にまとめることができます。
- 技術的な知識がない関係者でも、スキーマ定義を理解し、分析することを可能にします
スキーマのドキュメントは人間が読みやすい形式で記述されているため、幅広い分野の専門家との連携が可能になり、スキーマの設計および改善の過程で、専門家が内容を理解し、意見を述べることができます。
- 自動化されたツールを使うことで、作業が容易になります。
本当に、ソフトウェアがそのプロセスを容易にしているのだから、スキーマを記録しない理由はありません。ここでは、XMLSpyというツールを使って、どのようにスキーマを記録できるかを見ていきましょう。
XMLSpyは、XSDスキーマ、JSONスキーマ、およびXBRLタクソノミースキーマに対して、完全にカスタマイズ可能でありながら、網羅的なスキーマドキュメントを提供します。その仕組みについて、詳しく見ていきましょう。
XMLスキーマのドキュメントを生成します
XMLSpy XMLエディターは、XMLスキーマ、JSONスキーマ、XBRLタクソノミーのスキーマ、そしてWSDL定義に至るまで、自動的にドキュメントを生成する機能を提供しています。この機能は、それぞれのスキーマに対して同様の手順で動作します。スキーマのドキュメントを開き、「スキーマ設計」メニューから「ドキュメント生成」を選択してください。
組み込みのドキュメントテンプレートを使用することもできますし、Altova StyleVisionがインストールされている場合は、必要に応じて自由にカスタマイズした独自のテンプレートを作成することも可能です。その後、ドキュメントをHTML、Word、RTF、またはPDF形式で生成するかを選択してください。（注：PDF形式での生成には、StyleVisionが同じマシンにインストールされている必要があります。）
その他のオプションでは、画像の扱い方や、具体的にどの要素や詳細をドキュメントに含めるかを定義できます。それでは、XSDの生成されたドキュメントを見てみましょう。その後、JSONやXBRLのスキーマをドキュメント化するための様々なオプションをご紹介します。
以下は、XMLSpyのサンプルプロジェクトに含まれる「経費報告」XSDのHTMLドキュメントの一部です。
スキーマの構成要素は、対応するソースコードとともにグラフィカルに表示され、ハイパーリンクを使用することで、関連する要素、属性、およびデータ型の詳細情報を容易に参照することができます。
特性と詳細な情報が明確に表示され、すぐに分析を行うことができます。
他のスキーマから要素が取り込まれている場合、それらのスキーマについてもドキュメントが作成されます。
JSONスキーマのドキュメントを生成します
現在進行中の導入状況は、 JSONスキーマ JSON形式のデータストリームに対してデータ検証を適用することは、このようなスキーマに関するドキュメントの重要性を改めて強調することにもなります。
JSONスキーマのドキュメント生成オプションは、XSDのものと似ていますが、もちろんJSONに特化したものであり、プロパティ、配列、パターンなどの詳細を含めることができます。
XBRL分類体系に関するドキュメント
さて、ここからはXBRLの分類体系について説明します。これらは非常に複雑な構造を持つため、そのドキュメントは、分類体系の開発者だけでなく、会計士や金融分野の専門家など、技術的な知識を持たないXBRLに関わる人々にとっても非常に役立ちます。
XBRLタクソノミーエディタのXBRLメニューにある「ドキュメント生成」コマンドは、通常のオプションに加え、今回はXBRLの構成要素であるラベルやリンクベースに特化したオプションを提供します。
XSD、JSON、またはXBRLのスキーマを扱っている場合でも、ドキュメント生成によってスキーマの構造や関連性を視覚的に把握し、理解し、伝えることができるというメリットは数多くあります。そして、XMLSpyで数秒で自動的にドキュメントを生成できるという事実は、作業を円滑に進めるためのあらゆる障壁を取り除きます。
もしあなたがまだ当社の顧客でない場合は、以下のことができます XMLSpyを30日間、無料で試用できます.