ピアレビュー用の XSD スキームのフォーマット
質問
XSD スキームで表現されるデータ モデルを設計しました。データ モデルは、WSDL 記述子の Web サービス パラメーターとして使用される型も提供します。
XSD スキームを配布し、関係者にデータ モデルのピアレビューを依頼したいと考えています。
査読の基礎としてどのようなツールまたはプレゼンテーション方法を使用することをお勧めしますか?データ モデルは、少なくともパラメータの意味論的な意味に関しては、専門知識のない人でも読みやすいものである必要があります。
編集:
もう少し詳しく言うと:もちろん、構文的には、スキームは検証されます。実際、私はすでに JAXB で生成されたクラスに基づくコードに取り組んでいます。私の目標は
- データモデルをフリーズし、したがって入力パラメーターをフリーズします
- 何も迷子になったり忘れられたり、セマンティック(ビジネスに関連する)の視点から忘れたり忘れたりすることはありません。
編集2
私は、データモデルを広めるにはどうすればよいかを考えてきました。XSD スキーマ用の JavaDoc のようなものを考えています。そのようなものが存在するかどうか知っている人はいますか?基本的には XSLT のセットで行われますよね?
解決
他のヒント
何かのためにXSDを使用することをお勧めします。具体的には、実際のコードとして例を示しながら、実際のアプリケーションをいくつか示します。
実際のアプリケーションは、スキーマを興味深いものにします。例は、大きく、洗練された、または完全に現実的である必要はありません。コンパイルするだけです。他の人は、コードサンプルをコピーして貼り付けたいと思うでしょう。
これらの例は、「hello world」です。スキーマの。そして、それらはスキーマの一種の単体テストとして機能します。
XMLスキーマでJavadocに最も近いのは、スキーマから生成されたソースでJavadocツールを実行していることです。これには2つのことが必要です。1)スキーマに内部注釈要素が文書化されていること、2)ソースジェネレーターがそれらの注釈をJavadoc要素として使用していること。
非常に便利なOxygen XML開発者は、ドキュメントの生成もサポートしています。 http://www.oxygenxml.com/xml_schema_documentation.html (商用ですが、完全に機能する30日間の試用版があります)
今すぐ試してみましょう。すべてのタイプのドキュメントを生成する簡単な方法が必要で、xsd:documentationの説明を単純なインターフェイスの説明として使用します...
** 開示:私は、後述するドキュメント ツールのプロデューサーである Innovasys で働いています。 *
見てみるといいでしょう イノバシスのドキュメント!バツ. 。すべての要素、単純型、複合型、グループ、属性グループに対して構造化されたリンクされたページを自動的に生成するだけでなく、リンクされた XSD 図 (シーケンス/選択などを含む) と、XSD からの注釈を含む構造テーブルも生成します。スキーマ内の要素間の関係を理解します。出力はテンプレートベースであるため、好みのスタイルや構造に適応させることができます。Web 対応の HTML またはコンパイルされたヘルプ ファイルへの出力を構築します。
ユニークな点として、自動的に生成されるものや XSD ソースからの注釈を補足する追加コンテンツを作成できる WYSIWYG エディターも含まれているため、ピアレビューに追加のコンテキスト情報を提供できます。また、生成された出力を閲覧しているユーザーがコメントやフィードバックを記録できるようにするコミュニティ拡張機能もあり、Document! 内から直接閲覧して操作することができます。バツ。