RE: Tech Writing Question

Subject: RE: Tech Writing Question
From: "Jonathan West" <jwest -at- mvps -dot- org>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 17 Apr 2002 23:28:35 +0100




>
> 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?

Yes to both. Sometimes there is design documentation you can get hold of,
sometimes they start coding without ever writing down the design.

Beware the latter kind of job. The design (especially the UI) is usually
rather more incoherent, and you usually end up acting as their tester. When
asking "what does this do?" about some feature of the program, they will
often discover either that it doesn't do very much, or that it doesn't do
what somebody had intended it to.

Good luck!

Regards
Jonathan West



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.


References:
Tech Writing Question: From: Richard Sanchez

Previous by Author: RE: Comments lost from Word to PDF
Next by Author: Re: Goodbye TECHWR-L
Previous by Thread: Tech Writing Question
Next by Thread: Re: Tech Writing Question


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


Sponsored Ads