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:peter -at- softwell -dot- co -dot- uk (Peter Hirons) To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 16 Feb 2003 11:12 +0000 (GMT Standard Time)
> >
> >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?"
>
> That is never a question. Documentation documents actual behavior,
> or else it is fiction.
>
> One might say "X is intended to do Y, but it actually behaves like
> this..."
> of course.
>
I agree totally, but it does serve to concentrate the developers' minds
:-)
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.