About this post: This guest blog was written by Brigitte Meijer, Information Analyst & Requirements Engineer at BmIT. She is a valued collaborator of ours who we regularly hire for consultancy. We have asked her to share her views on our recently released plugin, the XSD Viewer for Confluence. This is what she wrote:
We are currently developing webservices and an ebMS interface for a customer. This involves making a lot of XSD’s…
Previously we wrote the functional and technical documentation for these interfaces in MS Word, made tables explaining the elements by hand and used a development tool to create schematic images. This was a lotof work and it was very difficult to keep the XSD and the documentation in sync.
Documenting an XML Schema Definition (XSD) can be a tiring process. You first load a file in an XSD viewing tool like XMLSpy, you then make screenshots of the areas of the definition you want to display and finally, you paste them into your documentation. Of course you have to repeat the entire process whenever the file changes in any way.
Avisi prides itself on being a cutting edge development organization so we felt strongly we needed to find a solution to this problem. Since we use Confluence as our documentation platform we chose to build a Confluence plugin: the XSD Viewer for Confluence.