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.
RE: When they shouldn't be experimenting (was RE: Encouraging learning---g by experimentation?
Subject:RE: When they shouldn't be experimenting (was RE: Encouraging learning---g by experimentation? From:Charles E Vermette <cvermette -at- juno -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 6 Dec 2002 08:49:14 -0500
/kevin asks:
<<<I'm in a constant, running battle to streamline my setup docs for
people who "just want to get on with it"...
If I leave out the "clutter"...I get reasonable-sounding complaints that
we must tell the users the information that they need in order to make
decisions... and to keep themselves out of trouble... and away from the
Customer Support line....
If I put in the "you need to know this" info, between the steps, I get
complaints that: "It's hard to follow. The
flow is interrupted. I want it all on one page..."
When possible, I herd them into a room and let them fight it out, and
simply present me with the consensus that they've achieved via democratic
or military means. But, it's not always possible. I think they're
catching onto my tactics...>>>
How do the rest of y'all deal with that particular dilemma?>>>
Short design answer: Sidebars and indents/bulleted lists. For online
docs, color coding. If set up correctly, it allows the user to see what
they need to see, and ignore the "clutter" if desired.
Short procedural answer: Write one topic with two/three different design
schemes. Show them to the various internal users. Explain that you want
to save time with a short deadline by deciding on a format before you
write 500 topics. Get consensus/sign-off on one. Then go to the wall if
someone waffles, emphasizing the waste of valuable time and resources.
I've ALWAYS found the wafflers back off.
Short political answer: there is no short answer to workplace politics -
and none that, given the zeitgeist of this list, I could say without
being misinterpreted. Given your past posts, I'd say your approach is the
best under the given the circumstances.
Charles E. Vermette
85 Washington Park Drive, Norwell MA 02061
781-659-1836
e-mail: cvermette -at- juno -dot- com
web: http://www.charlesvermette.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
Order RoboHelp X3 in December and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
---
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.
