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: Try selling the sizzle of what you do. From:John Posada <john -at- tdandw -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 18 Feb 2003 13:08:39 -0800
> Which leads to the inevitable question "Do you want me to document it the
> way the spec says it ought to work, or the way it actually works?"
Always how it currently works.
Had a product manager that wanted me to change the online help system I did
for a product. I'd written how to accomplish something, but it took WAY more
steps than it should have and was basically a workaround. If the user did it
the way they SHOULD have, the feature would not have worked...it had to do
with importing a prior dataset after an upgrade.
In short, I said no. He said yes. I said no. We appealed to a much higher
authority.
Boy, was the project manager upset with the decision. OTOH, the process got
redesigned and only then was I able to document it the way he wanted.
John Posada
Senior Technical Writer
john -at- tdandw -dot- com
Buy or upgrade to RoboHelp X3 today and receive the WebHelp
Merge Module for FREE ($299 value). RoboHelp X3's all-new
features include conditional text, completely re-engineered
printed documentation output, Context-sensitive Help Toolkit,
single-source layouts, and more!
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.