XSD schema formatting for peer review

Question

I developed a data model represented by an XSD schema. The data model also provides types that are used as web service parameters in the WSDL descriptor.

I would like to send an XSD schema and ask the people involved to consider the data model.

What presentation tool or method do you propose to use as a basis for expert reviews? The data model should be readable by unskilled people, at least when it comes to semantic parameter values

Edit:

To be more specific: Of course, syntactically, the circuit checks. In fact, I'm already working on code that is based on the generated JAXB classes. My goal

• to freeze the data model and thus the input parameters
• to make sure nothing is lost or forgotten from the semantic (meaning in terms of business).

Edit 2

I was thinking about how best to distribute a datamodel. I am thinking of something like JavaDoc for XSD schemes. Does anyone know if something like this exists? Basically this would be done with the XSLT suite, right?

Answer 1

I know the following tools that generate documentation from XML Schema (XSD) files:

• xs3p
  • XSLT stylesheet that generates one XHTML from XSD
• xsddoc
  • free / LGPL
  • mainly based on XSLT
  • JavaDoc output as
  • see xsddoc examples
• xnsdoc
  • improved commercial version of xsddoc
  • free for personal / educational use
  • JavaDoc output as
• XSDdoc 2.0
  • a commercial
  • JavaDoc output as

For a small XML schema, I would suggest using the XSLT xs3p stylesheet. For a more complex scheme, I suggest using xsddoc .

Answer 2

I recommend using XSD for something. In particular, show some actual applications, examples of which are real code.

Actual applications are what make the circuit interesting. The examples do not have to be large, complex or completely realistic. They just have to compile. Other people will want to copy and paste the code samples.

These examples are the "hello world" schemes. And they act as a kind of unit test for the circuit.

Answer 3

The closest thing to Javadoc for the XML schema that I saw is running the Javadoc tool for the source created from the schema. This requires two things: 1) that your schema contains internal annotation elements documenting it, and 2) your source generator uses these annotations as Javadoc elements.

Answer 4

** Disclosure: I work for Innovasys, the manufacturer of the documentation tool mentioned below *

You can take a look at the Innovasys document! X In addition to automatically creating a structured and linked page for each element, simple type, complex type, group, and attribute group, it will also generate related XSD diagrams (including sequences / selections, etc.) and structural tables that include annotations from your XSD and understand the relationships between elements in your circuits. The result is template-based, so you can adapt it to your preferred style and structure. It will generate output in ready-made html files or compiled help files.

Uniquely, it also includes the WYSIWYG editor, which allows you to add additional content in addition to materials that are automatically generated, and annotations from the XSD source - so you can provide additional contextual information for your expert review. There is also a community extension feature that allows people to view the generated output to record comments and feedback and which can be viewed and executed directly from the document! X.

Answer 5

A very useful Oxygen XML developer also supports the creation of documentation, see http://www.oxygenxml.com/xml_schema_documentation.html (commercial, but there is a fully functional 30-day trial version)

I'll try now, I need an easy way to create a document with all types and an accessible description of xsd: documentation as a simple description of the interface ...