[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

XML Documentation Anyone?

Subject: XML Documentation Anyone?
From: Vickie Camgros <vcamgros -at- persistence -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 28 Apr 2000 08:37:44 -0700

At 10:57 AM -0400 4/28/00, Ron Rhodes wrote:

Dear Techwhirlers,

I have found a lot of great sites for XML. But none of them really cover
how a technical writer could use XML for documentation. Does anyone know of
any sites that instruct the tech writer on producing XML-based documentation
that also provide good examples of XML pages, DTDs, and XSL style sheets?

I promise to post the results after a few days of gathering suggestions.

I have a related question: Does anyone know of sources on how to document
XML itself. Our product uses a number of XML-format files for configuration.
We document the tags and their uses, but have yet to find any sort of
standard for the form of this documentation.

Lest you say "The DTD should be self-documenting," let me counter that poin
here. DTDs contain the grammar, but not the semantics of a document. They
don't explain how elements interrelate. For example, if a certain setting
on one element implies a restriction on the setting of another element. So we
do need additional documentation. Of course, we also provide the DTDs.

If there is a lot of interest/response to this topic, I'll be glad to post a summary.

V.




Previous by Author: If this ain't fun it...
Next by Author: Re: readme.txt or readme.doc?
Previous by Thread: HTML Help
Next by Thread: WebWorks and context-sensitivity

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads