Re: Tech Writing Question
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.
Kat Nagel, writer of speculative technical fiction,
who often volunteers to write and maintain
the requirements and design docs because
sometimes that's the only way to have a clue...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
References:
Tech Writing Question: From: Richard Sanchez
Previous by Author:
Re: Winword.exe error in Robohelp
Next by Author:
Re: Tech Writing Question--Specs
Previous by Thread:
Re: Tech Writing Question--Specs
Next by Thread:
RE: Tech Writing Question
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads