Formatierung XSD-Schema für Peer-Review

Question

Ich entwarf ein Datenmodell, die von einem XSD-Schema dargestellt wird. Das Datenmodell stellt auch die Typen, die als Web-Service-Parameter in einer WSDL-Beschreibung verwendet werden.

Ich mag um das XSD-Schema senden und die beteiligten Personen Peer fragt das Datenmodell überprüfen.

Welches Werkzeug oder Präsentationsmethode würde vorschlagen, Sie als Grundlage für die Peer-Review-Verfahren verwendet werden? Das Datenmodell sollte für nicht-qualifizierte Menschen lesbar sein, zumindest wenn es um die semantische Bedeutung der Parameter

Edit:

Um genauer zu sein: Natürlich, syntaktisch, das Schema validiert. Eigentlich arbeite ich bereits auf Code, der auf JAXB generierten Klassen basiert. Mein Ziel ist es

1. das Datenmodell gefrieren und somit die Eingangsparameter
2. , um sicherzustellen, nichts verloren ging oder aus einem vergessenen semantisch (im Sinne von geschäftsrelevanten) Sicht.

Edit 2

Ich habe darüber nachgedacht, wie es wäre wahrscheinlich am besten ein Datenmodell herum zu verbreiten. Ich denke an so etwas wie ein JavaDoc für XSD-Schema. Wer weiß, ob so etwas existiert? Grundsätzlich wäre es mit einem Satz von XSLTs getan wird, nicht wahr?

Answer 1

Ich kenne die folgenden Tools, die Dokumentation von XML-Schema-Dateien (XSD) erzeugen:

• xs3p
  • XSLT Stylesheet, das einzelne XHTML von XSD
  erzeugt
• xsddoc
  • Frei / LGPL
  • hauptsächlich XSLT Basis
  • JavaDoc wie Ausgang
  • finden Sie unter xsddoc Beispiele
• xnsdoc
  • verbesserte kommerzielle Version von xsddoc
  • für die persönliche / pädagogische Nutzung
  • JavaDoc wie Ausgang
• XSDdoc 2.0
  • kommerzielle
  • JavaDoc wie Ausgang

Für kleines ein XML-Schema, würde ich wahrscheinlich vorschlagen, die xs3p XSLT-Stylesheet verwenden. Für mehr ein komplexes Schema, ich schlage vor, mit xsddoc .

Answer 2

Ich empfehle mit die XSD für etwas. Insbesondere zeigen einige aktuelle Anwendungen, mit Beispielen als echten Code.

Die tatsächlichen Anwendungen sind, was ein Schema interessant zu machen. Die Beispiele müssen nicht groß, anspruchsvoll oder völlig realistisch sein. Sie müssen nur kompilieren. Andere Leute wollen kopieren und die Codebeispiele einfügen.

Diese Beispiele sind die „Hallo Welt“ des Schemas. Und sie fungieren als eine Art von Unit-Test für das Schema.

Answer 3

Die nächste Sache zu Javadoc für ein XML-Schema, das ich gesehen habe, ist das Javadoc-Tool auf Quelle aus dem Schema erzeugt läuft. Dies erfordert zwei Dinge: 1) Dass Ihr Schema interne Beschriftungselemente dokumentiert hat, und dass 2) Ihre Quelle Generator verwendet diese Anmerkungen als Javadoc Elemente

.

Answer 4

Der sehr nützlich Oxygen XML-Entwickler unterstützt auch Dokumentation zu erzeugen, siehe http://www.oxygenxml.com/xml_schema_documentation.html (Kommerziell, aber es gibt einen voll funktionsfähigen 30-Tage-Test verfügbar)

Ich werde es jetzt ausprobieren, benötigen eine einfache Möglichkeit, ein Dokument mit allen Typen und verfügbar xsd zu generieren: Dokumentation Beschreibung als eine einfache Schnittstellenbeschreibung ...

Answer 5

** Disclosure: Ich arbeite für Innovasys, der Hersteller des Dokumentations unten genannten *

Sie können einen Blick auf Innovasys Dokument! X . Sowie automatisch eine strukturierte und verknüpfte Seite für jedes Element, einfachen Typen, komplexen Typen, Gruppe und Attributgruppe Erzeugt es wird auch verknüpfte XSD-Diagramme (einschließlich Sequenzen / Auswahl etc.) und Struktur-Tabellen, die die Anmerkungen von Ihrem XSDs umfassen generieren und Sinn der Beziehungen zwischen den Elementen in Ihrem Schema. Die Ausgabe ist Vorlage basiert, so dass Sie es zu Ihrem bevorzugten Stil und die Struktur anpassen kann. Es wird ausgegeben, um Web bereit html oder kompilierten Hilfedateien erstellen.

Einzigartig enthält es auch einen WYSIWYG-Editor, den Sie zusätzliche Inhalte erlaubt Autor das Zeug zu ergänzen, die automatisch generiert wird und die Anmerkungen aus der XSD Quelle - so können Sie zusätzliche Kontextinformationen für Ihren Peer-Review zur Verfügung stellen. Es gibt auch eine Gemeinschafts Extensions-Funktion, die Menschen sehen die generierten Ausgabe aufzeichnen Kommentare und Feedback und die direkt aus Dokument kann betrachtet werden und actioned erlaubt! X.