Formatage du schéma XSD pour examen par les pairs

Question

J'ai conçu un modèle de données qui est représenté par un schéma XSD. Le modèle de données fournit également les types utilisés comme paramètres de service Web dans un descripteur WSDL.

J'aimerais envoyer le schéma XSD et demander aux personnes impliquées d'examiner le modèle de données par des pairs.

Quel outil ou quelle méthode de présentation proposeriez-vous d’utiliser comme base pour les examens par les pairs? Le modèle de données doit être lisible par les personnes non qualifiées, du moins en ce qui concerne la signification sémantique des paramètres

Modifier:

Pour être plus précis: bien sûr, syntaxiquement, le schéma valide. En fait, je travaille déjà sur du code basé sur les classes générées par JAXB. Mon objectif est

1. pour figer le modèle de données et ainsi les paramètres d'entrée
2. pour être sûr rien n'a été perdu ou oublié d'un sémantique (au sens de point de vue des entreprises).

Modifier 2

J'ai réfléchi à la meilleure solution pour diffuser un modèle de données. Je pense à quelque chose comme un JavaDoc pour les schémas XSD. Quelqu'un sait si quelque chose comme ça existe? Fondamentalement, cela serait fait avec un ensemble de XSLT, non?

Answer 1

Je connais les outils suivants qui génèrent de la documentation à partir de fichiers de schéma XML (XSD):

• xs3p
  • Feuille de style XSLT générant un seul XHTML à partir de XSD
• xsddoc
  • gratuit / LGPL
  • principalement basé sur XSLT
  • JavaDoc like output
  • voir les exemples de xsddoc
• xnsdoc
  • version commerciale améliorée de xsddoc
  • gratuit pour un usage personnel / éducatif
  • JavaDoc like output
• XSDdoc 2.0
  • commercial
  • JavaDoc like output

Pour un petit schéma XML, je suggérerais probablement d’utiliser la feuille de style xs3p XSLT. Pour un schéma plus complexe, je suggère d'utiliser xsddoc .

Answer 2

Je recommande d'utiliser le XSD pour quelque chose. Plus précisément, montrez des applications réelles, avec des exemples sous forme de code réel.

Les applications réelles sont ce qui rend un schéma intéressant. Les exemples ne doivent pas nécessairement être volumineux, sophistiqués ou totalement réalistes. Ils doivent juste compiler. D'autres personnes voudront copier et coller les exemples de code.

Ces exemples sont le "bonjour le monde". du schéma. Et ils agissent comme une sorte de test unitaire pour le schéma.

Answer 3

La chose la plus proche de Javadoc pour un schéma XML que j'ai vue consiste à exécuter l'outil Javadoc sur une source générée à partir du schéma. Cela nécessite deux choses: 1) que votre schéma soit documenté par des annotations internes et 2) que votre générateur de source utilise ces annotations comme éléments Javadoc.

Answer 4

Le très utile développeur XML Oxygen prend également en charge la génération de documentation, voir http://www.oxygenxml.com/xml_schema_documentation.html (commercial, mais il existe un essai totalement fonctionnel de 30 jours)

Je vais l'essayer maintenant, il me faut un moyen simple de générer un document avec tous les types et la description xsd: documentation disponible en tant que description d'interface simple ...

Answer 5

** Divulgation: je travaille pour Innovasys, le producteur de l'outil de documentation mentionné ci-dessous *

Vous pouvez consulter le document Innovasys! X . En plus de générer automatiquement une page structurée et liée pour chaque élément, type simple, type complexe, groupe et groupe d'attributs, il générera également des diagrammes XSD liés (y compris des séquences / choix, etc.) et des tables de structure incluant les annotations de vos fichiers XSD et donner un sens aux relations entre les éléments de vos schémas. La sortie est basée sur un modèle afin que vous puissiez l'adapter à votre style et à votre structure préférés. Il générera la sortie dans des fichiers d’aide HTML ou compilés prêts pour le Web.

Unique, il inclut également un éditeur WYSIWYG qui vous permet de créer du contenu supplémentaire pour compléter les éléments générés automatiquement et les annotations de la source XSD - vous pouvez ainsi fournir des informations contextuelles supplémentaires pour votre évaluation par les pairs. Il existe également une fonctionnalité d'extensions de communauté qui permet aux personnes visualisant la sortie générée d'enregistrer des commentaires et des réactions. Cette fonctionnalité peut être visualisée et traitée directement à partir de Document! X.