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:When you need to restructure? From:"Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 30 Apr 2001 11:02:13 -0400
Jane Carnall reports: <<I've just had a really productive meeting with a
couple of designers (internal customers for the documentation set) and have
come to the conclusion that the documentation set pretty much needs some
terrific
restructuring. Since the content also needs some considerable rewriting, I'm
going to just start fresh from brand-new templates, rather than doing a lot
of copying, cutting, and pasting.>>
Sometimes it's actually considerably faster to use the old docs solely as a
reference rather than copying and modifying old text, with all the perils
that entails (e.g., some of the old stuff getting left in the final
manuscript, even though it no longer applies to the current structure).
That's particularly true if the people who did the previous docs used
templates clumsily or not at all.
<<Disadvantages: (1) For a while, it's going look like I not only haven't
done anything, I've actually gone backwards.>>
That's not a disadvantage if you get buy-in from the people who will be
monitoring your progress, and can meet the deadlines that you agree upon.
<<(2) I won't be able to take advantage of all the long, densely informative
but unstructured sentences that my predecessor wrote (this isn't really a
disadvantage)>>
If you're a moderately fast typist, this too may not be a problem.
<<can't think of any other disadvantages: well, except that my predecessor
is still working here and did put in a lot of work and I don't want to imply
that it was all worthless, because it wasn't>>
Then that's the way to sell your approach: "I really appreciate all the work
you put into the previous version; the current version has changed
enormously, but I can use everything you did as reference material and save
a lot of time in my research." Combine this with some people management
skills, and you're off to a good start: ask the predecessor to work with you
on the new template design and on explaining the travails endured during
creation of the previous version (so you don't encounter the same
problems--encountering new and different unforseen problems is so much more
enjoyable <g>). Make sure to accept the occasional compromise rather than
insisting on your own approach, and you'll earn a friendly colleague rather
than someone with wounded toes.
--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html
"The most likely way for the world to be destroyed, most experts agree, is
by accident. That's where we come in; we're computer professionals. We cause
accidents."-- Nathaniel Borenstein
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.