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: Reuse of text/modular information From:Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM> Date:Fri, 18 Jul 1997 14:28:04 -0400
Just because we are using mod docs doesn't mean
we forgo proofing the final product ;)
We handle the context changes with conditional text.
We proof our finals, because, as you point out,
while it's great that we can update one file that
is reused in several docs, it's just as easy to
make one mistake that appears in several docs.
We handle this using version control software and
labels to make sure that the final product has been
proofed and is preserved. Then, we update, update,
update all our projects, then update the final for
the next release, and so on. (Just as with non-modular
docs)
We have ways... :)
--
Alexia Prendergast
Senior Technical Writer
Seagate Software
alexiap -at- sems -dot- com
>----------
>From: geoff-h -at- MTL -dot- FERIC -dot- CA[SMTP:geoff-h -at- MTL -dot- FERIC -dot- CA]
>Sent: Friday, July 18, 1997 1:47 PM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: Reuse of text/modular information
>
> Reusing text ("modular information") is a great
> productivity booster for creating the _first draft_ of a
> manual or online help system, but that's all it ever is.
> First, context always changes somewhat, and you have to
> analyze the final text for each delivery medium to
> determine how well it's really going to work. Second, it's
> ridiculously easy to screw up something created using
> modular information through basic human carelessness. One
> great example: The manual for a GM station wagon I once
> owned frequently referred to an entirely different class of
> car... an obvious case of using database publishing and
> forgetting to proofread the final manual.
>
> --Geoff Hart @8^{)} geoff-h -at- mtl -dot- feric -dot- ca
> Disclaimer: Speaking for myself, not FERIC.
>
> TECHWR-L (Technical Communication) List Information: To send a message
>to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
>browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
>
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
