Page 1 of 1

Validation of schema documentation

Posted: Wed Oct 28, 2009 2:30 am
by Cheri Dennison
We make schema documentation from Oxygen available to our customers as an alternative way to view/understand the schemas for our services. I have a manager who is concerned about how we validate that the documentation is actually correct. It never occurred to me to worry about this, because I think of schema docs being automatically generated from the schema XML with XSLT. And I assume that you guys would have tested this feature to ensure it works as it should. Any thoughts on how I can calm my manager's fears on this?

Much thanks!
Cheri

Re: Validation of schema documentation

Posted: Wed Oct 28, 2009 10:34 am
by george
Dear Cheri,

oXygen generates the XML Schema documentation in an intermediary XML format that contains information extracted from the model used by oXygen in the Design page (the visual schema editor from oXygen).
On this intermediary XML oXygen applies XSLT stylesheets to obtain the different output formats that we offer: XHTML, PDF, DocBook.

The documentation generation went through our internal tests and we also did not receive any issues from our users related with the correctness of the schema documentation output.
More, the documentation includes also the source code for the documented components so one has available all the time also the actual schema code along with the documentation.

Best Regards,
George