Formato del esquema XSD para revisión por pares

Question

Diseñé un modelo de datos que está representado por un esquema XSD. El modelo de datos también proporciona los tipos que se están utilizando como parámetros de servicio web en un descriptor WSDL.

Me gustaría enviar el esquema XSD y pedir a las personas involucradas que revisen el modelo de datos.

¿Qué herramienta o método de presentación sugeriría que se use como base para las revisiones de pares? El modelo de datos debe ser legible para personas no cualificadas, al menos en lo que respecta a los significados semánticos de los parámetros

Editar:

Para ser más específico: por supuesto, sintácticamente, el esquema se valida. En realidad, ya estoy trabajando en el código que se basa en las clases generadas por JAXB. Mi objetivo es

1. para congelar el modelo de datos y por lo tanto los parámetros de entrada
2. para asegurarse nada se perdió ni se olvidó de un semántico (en el sentido de punto de vista relevante para el negocio.

Editar 2

He estado pensando en cómo probablemente sería mejor difundir un modelo de datos. Estoy pensando en algo como un JavaDoc para esquemas XSD. Alguien sabe si algo así existe? Básicamente se haría con un conjunto de XSLT, ¿verdad?

Answer 1

Conozco las siguientes herramientas que generan documentación a partir de archivos de esquema XML (XSD):

• xs3p
  • hoja de estilo XSLT que genera XHTML único desde XSD
• xsddoc
  • gratis / LGPL
  • principalmente basado en XSLT
  • JavaDoc como salida
  • vea ejemplos de xsddoc
• xnsdoc
  • versión comercial mejorada de xsddoc
  • gratis para uso personal / educativo
  • JavaDoc como salida
• XSDdoc 2.0
  • comercial
  • JavaDoc como salida

Para un esquema XML pequeño, probablemente sugeriría usar la hoja de estilo XSLT xs3p . Para ver un esquema más complejo, sugiero usar xsddoc .

Answer 2

Recomiendo usar el XSD para algo. Específicamente, muestre algunas aplicaciones reales, con ejemplos como código real.

Las aplicaciones reales son las que hacen que un esquema sea interesante. Los ejemplos no tienen que ser grandes, sofisticados o completamente realistas. Sólo tienen que compilar. Otras personas querrán copiar y pegar los ejemplos de código.

Estos ejemplos son el " hello world " del esquema. Y actúan como una especie de prueba unitaria para el esquema.

Answer 3

Lo más cercano a Javadoc para un esquema XML que he visto es ejecutar la herramienta Javadoc en el origen generado a partir del esquema. Esto requiere dos cosas: 1) que su esquema tiene elementos de anotación interna que lo documentan, y que 2) su generador de origen utiliza esas anotaciones como elementos Javadoc.

Answer 4

El muy útil desarrollador de Oxygen XML también admite la generación de documentación, vea http://www.oxygenxml.com/xml_schema_documentation.html (comercial, pero hay una versión de prueba de 30 días completamente funcional disponible)

Lo intentaré ahora, necesito una forma sencilla de generar un documento de todos los tipos y xsd disponible: descripción de la documentación como una simple descripción de la interfaz ...

Answer 5

** Divulgación: trabajo para Innovasys, el productor de la herramienta de documentación que se menciona a continuación *

Puede consultar ¡Documento de Innovasys! X . Además de generar automáticamente una página estructurada y vinculada para cada elemento, tipo simple, tipo complejo, grupo y grupo de atributos, también generará diagramas XSD vinculados (incluidas secuencias / opciones, etc.) y tablas de estructura que incluyen las anotaciones de sus XSD y dar sentido a las relaciones entre los elementos en sus esquemas. La salida se basa en plantillas para que pueda adaptarla a su estilo y estructura preferidos. Construirá el resultado para html preparado para la web o archivos de ayuda compilados.

De forma única, también incluye un editor WYSIWYG que le permite crear contenido adicional para complementar las cosas que se generan automáticamente y las anotaciones de la fuente XSD, para que pueda proporcionar información contextual adicional para su revisión por pares. También hay una función de extensiones comunitarias que permite a las personas ver el resultado generado para grabar comentarios y comentarios, y que se pueden ver y actuar directamente desde el documento. X.