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: techwr-l digest: April 30, 2002 From:"Margaret Secara" <margaret -dot- secara -at- alphather -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 01 May 2002 08:54:21 -0700
When in that situation, I just write it the way it's supposed to work. By the time it's all released, that buggy feature will (probably) have been whipped into shape.
At least, that's the theory :)
Maggie Secara
>>> "Blount, Patricia" <PATRICIA -dot- BLOUNT -at- ca -dot- com> Wednesday, May 01, 2002 >>>
Hi,
I need the benefit of your collective experiences... as tech writers, we frequently are documenting products that are still under development, so that the documents can ship with the product, no?
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..."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
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
---
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.
