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.
>From a documentation management point of view:
Document it the way it is supposed to work and let the
real world catch up.
>From a user advocate point of view:
What are we doing releasing a product with a known bug?
>From a user service point of view:
Of course you let the user know that they may need a
workaround and what that workaround is.
>From a marketing point of view:
Don't use documentation to highlight flaws in our product.
Let the user work it out with tech support.
Confession: I usually take the documentation management
point of view. Many times our update or patch is in place
by the time the user gets around to the documentation.
Jim Shaeffer (jims -at- spsi -dot- com)
Patricia Blount [mailto:PATRICIA -dot- BLOUNT -at- ca -dot- com] asked:
> OK, so what have you done when faced with a feature that is
> at best, "buggy". Sometimes it works, sometimes it doesn't.
> If you write a procedure according to the way it's supposed
> to work (i.e., design intention), then your book is wrong at
> least part of the time.
>
> I'm wondering if the books should contain an alternative
> section, something like "What to do if this procedure fails
> to produce the desired result..."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
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.
