[XML-DEV Mailing List Archive Home] [By Thread] [By Date] [Recent Entries] [Reply To This Message]

Re: documenting schemas/DTDs

  • From: David Megginson <david@m...>
  • To: "'xml-dev@i...'" <xml-dev@i...>
  • Date: 18 Nov 1999 06:16:56 -0500

documenting xml schemas
"W. Eliot Kimber" <eliot@i...> writes:

> My personal feeling, based on many years of painful experience
> developing and maintaining DTDs of varying scale and complexity and
> documenting same (including the original version of IBM's IBM ID Doc
> application and the second edition of the HyTime architecture, both
> massive documentation projects) is that the only practical way to
> develop and manage non-trivial document types is by making the
> documentation the primary definition, with the working declarations
> extracted from it using some sort of make process.  


> If you are are creating DTD-syntax DTDs, the syntax of DTDs is simply
> not up to the task of maintaining and managing documentation of any
> useful sophistication. 

I agree very strongly with Eliot, perhaps because we both have a lot
of experience in creating (rather than just processing) user

Even a schema spec that allowed very rich documentation in each
declaration would be at best the equivalent of JavaDoc, and that's not
good enough.  The problem (and this is a classic in tech writing) is
that the optimal way to arrange information for a human reader is
rarely the optimal way to arrange information for technical
implementation, and vice versa.

Except in very rare circumstances, for example, any tech writer who
structures a user manual around the UI ("Chapter 1: the File Menu")
deserves to be fired without severance pay, ritually humiliated in
front of the whole office, and rolled all the way out to the parking
lot in a garbage can -- the fact that they aren't is a testimony to
the shortage of even minimally competent tech writers out there.

Personally, I deserve the same treatment for never having provided a
proper SAX 1.0 spec -- I'll try to remedy that situation before
everyone figures out how to send a garbage can through e-mail.

All the best,


David Megginson                 david@m...

xml-dev: A list for W3C XML Developers. To post, mailto:xml-dev@i...
Archived as: http://www.lists.ic.ac.uk/hypermail/xml-dev/ and on CD-ROM/ISBN 981-02-3594-1
To unsubscribe, mailto:majordomo@i... the following message;
unsubscribe xml-dev
To subscribe to the digests, mailto:majordomo@i... the following message;
subscribe xml-dev-digest
List coordinator, Henry Rzepa (mailto:rzepa@i...)


Purchasing Stylus Studio from our online shop is Easy, Secure and Value Priced!

Buy Stylus Studio Now

Download The World's Best XML IDE!

Accelerate XML development with our award-winning XML IDE - Download a free trial today!

Don't miss another message! Subscribe to this list today.
First Name
Last Name
Subscribe in XML format
RSS 2.0
Atom 0.3

Stylus Studio has published XML-DEV in RSS and ATOM formats, enabling users to easily subcribe to the list from their preferred news reader application.

Stylus Studio Sponsored Links are added links designed to provide related and additional information to the visitors of this website. they were not included by the author in the initial post. To view the content without the Sponsor Links please click here.

Site Map | Privacy Policy | Terms of Use | Trademarks
Free Stylus Studio XML Training:
W3C Member
Stylus Studio® and DataDirect XQuery ™are products from DataDirect Technologies, is a registered trademark of Progress Software Corporation, in the U.S. and other countries. © 2004-2013 All Rights Reserved.