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.
At 3:11 PM -0700 4/17/02, Richard Sanchez wrote:
>I have another question regarding writing user
>manuals.
>
>Is there often a step where the tech writer has access
>to some type of spec type documentation or writers
>just start from scratch?
If you're lucky, you will get a copy of the system specifications or
the requirements doc. If you're REALLY lucky, one of these (rarely
both) will bear some resemblance to the product prototype that you
will use for screen shots. And if you are truly blessed by the gods,
the specs/requirements/prototype will actually include all the
functions (and only those functions) that are operational in the
product that is shipped.
We get different information here. Occasionally we get the specifications
on instruments. Typically, it is a 30-150 page proposal in flux. "Can you
write this up? Wait a minute. We've revised section 1.3.4a." I have coined
the word vapordoc, meaning documentation on vaporware.
Greg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
