Re: Guess what: we suck!

Subject: Re: Guess what: we suck!
From: "Mike Starr" <mikestarr-techwr-l -at- writestarr -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Sat, 18 Aug 2007 00:55:23 -0500

The problem is that we technical writers don't get to decide what features
deserve to be incorporated into a product. But to me, documentation that
doesn't explain all of those features is unacceptable. We should be
providing task-based documentation to guide users through the most common
tasks but we should also be providing reference-based documentation that
explains whatever's there to be explained. The better we do at this sort of
stuff, the less often users will feel the need to pick up the phone and call

Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Website developer
Graphic Designer - Desktop Publisher - MS Office Expert
Phone: (262) 694-1028 - Tollfree: (877) 892-1028 - Fax:(262) 697-6334
Email: mike -at- writestarr -dot- com - Web:

----- Original Message -----
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Friday, August 17, 2007 2:21 PM
Subject: Re: Guess what: we suck!

> In my experience it has more often been developers and
> product managers who want big, thick, detailed tomes
> that cover every feature and every possible function of
> the product, to protect them from their own ignorance.
> Having failed to adequately research what their users
> really want from the product, how they will actually be
> using it and what they need to get it to do what it's
> supposed to, they cram in everything but the kitchen
> sink. Then their help lines are buried under a flood of
> calls from users who couldn't care less about "in-depth
> coverage" and just want to know "how do I make it do...?"
> Gene Kim-Eng


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Re: Guess what: we suck!: From: Chris Borokowski
Re: Guess what: we suck!: From: Gene Kim-Eng

Previous by Author: Re: Working with large documents in Word
Next by Author: Re: Guess what: we suck!
Previous by Thread: Re: Guess what: we suck!
Next by Thread: Re: Guess what: we suck!

What this post helpful? Share it with friends and colleagues:

Sponsored Ads