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.
Janice Gelb wrote:
>
> What you're documenting, I think, should be what the user needs to know
> to use the software to get something done. Most of the time, that just
> means the GUI, not the underlying software. As I told one of my writers
> once when an engineer was bugging him to include more of the underlying
> technology, the name of the book is "Using XProduct" not "Everything
> You Always Wanted to Know About XProduct But Were Afraid to Ask."
>
At my last job, one of our programmers would solemnly explain to me
that such and such dialog box was an "MDI Child". I'd take the note,
mutter "yeah whatever", and then tell the user that from box such and
such they could change the master units etc.
Sometimes he'd wonder where all his lovely technical detail went, but
I'd just smile and say it was edited out.
Ginna
Ginna Watts - Technical Writer
Quester Tangent Corporation
gwatts -at- questercorp -dot- com
Sidney, BC
