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: Giving up on XML From:Ned Bedinger <doc -at- edwordsmith -dot- com> To:Mike Starr <mikestarr-techwr-l -at- writestarr -dot- com> Date:Mon, 19 Mar 2007 12:26:05 -0700
Mike Starr wrote:
> <snip>
> But just out of curiosity, if one skips a level, is that inherently evil?
> Isn't the resulting document still intact with respect to the heirarchy? And
> even if it isn't is that in itself a fatal flaw if I can look at the
> document structure and still make sense of it? In my case, there's nobody to
> impose structure on my documents other than my own built-in standards that I
> adhere to.
This is an issue of documentation methodology and style, but not really
so much about structure in the XML sense.
But you're right, documentation has other uses for structure (as a
template for information collection, as a visual cue to a document's
organization, ...), and IMHO human consumers and writers of
documentation do seem to prefer documentation that has not been fully
elaborated with empty-but-logical structure. I think of XML as a system
for describing information to computers. Indeed, one of the standard
uses of XML is for identifying data elements in an electronic stream of
information, for example from a web form to a database, or from a bank
ATM to the transaction processing system. Sometimes we need to do
documentation for people that way, sometimes not.
Ned Bedinger
doc -at- edwordsmith -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-