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:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:"techwhirlers" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 19 Mar 2007 10:07:18 -0700
Single sourcing, for one. A lot of SW uses XML for the various
bits of text displayed by dialogs, wizards, etc. If the manuals,
help, brochures, websites, etc., that also need to use these same
bits of text all draw them from the same place the product does,
then a writer managing the text displayed by the product can
update and synchronize all the end uses of those bits with one
edit. If you're a sole writer or manager of a small team and not
tasked with maintaining consistent output from a department
of 50+ people, the only "compliance" to some external "standard"
that should need to come into such a scenario is that the tools
that produce all the different end uses are able to recognize and
use the same XML without polluting it with various proprietary
add-ons.
Yes, I know that many writers on this list will respond with
grumbles about how they're not considered legitimate members
of the SW development team, that nobody ever consults them
about managing the text displayed by the products they're
documenting, etc. But if your writing team and/or process are
so undisciplined that you need rigid, automated document
standards beyond Word or Frame style templates to maintain
consistent document structure, maybe you should ask yourself
if there aren't good reasons why you're not being asked to
contribute in this area.
Gene Kim-Eng
----- Original Message -----
From: <quills -at- airmail -dot- net>
> Then why bother at all? If you don't follow the structure, it becomes
> irrelevant. valid and well-formed is not a holy grail, nor is it a
> goal. It is a standard. If you deviate from that standard, you are no
> longer in compliance. If compliance with the standard isn't
> important, why bother with a standard?
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-