TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Documenting an XML format -- how much detail? From:Sean Wheller <seanwhe -at- yahoo -dot- com> To:"Mike O." <obie1121 -at- yahoo -dot- com> Date:Thu, 15 Jan 2004 21:42:40 -0800 (PST)
--- "Mike O." <obie1121 -at- yahoo -dot- com> wrote:
>
> Jon Jacob Jinglehymerschmidt wrote:
>
> > Has anyone here had to document an XML interface?
>
> Yes, here are some suggestions:
>
> - Make sure you provide a library of sample code
> that shows input and
> output.
I agree. Sample code is a must.
>
> - Provide an online test server where your audience
> can cut-and-paste your
> sample input, submit it, and get the same output as
> in your sample output.
> Then they can modify the code and use the test
> server to test their own new
> code.
Yes, yes, and yes.
[snip]
>
> - For each element and attribute, write a good
> description of its purpose,
> how it is useful, and what happens when you submit
> it to your server.
You can use the xs:documentation element and then use
xi:include in you document to "suck" the value into
your document during transformation.
There are also other techniques such as Norman Walsh's
weave.xsl
