Re: where do docs fit in the development process?
Make sure that the programmers understand that you are trying to ensure that the final user will want to use the program. That you are trying to make the user understand what the programmers have done. You have to live in their back pocket.
Also that poor or inaccurate documentation gives the user the impression of lesser quality in the product as a whole, which is bad for *everybody* (including developers).
Someone else mentioned the importance of developing relationships -- being a polite "nag" helps a bit when trying to get feedback from not-so-cooperative reviewers. Go see them (or phone them if they're remote) regularly and diplomatically ask them to review the doc. Avoid ticking them off or you risk actually pushing them away. Of course, all these things are easier to do if you've already developed a relationship with them.
David Wood
Freelance Technical Writer
DavidWood -at- canada -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you. 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:
Re: where do docs fit in the development process?: From: Andrew Plato
Re: where do docs fit in the development process?: From: quills
Previous by Author:
Microsoft documentation standard
Next by Author:
RE: Applying On-Line
Previous by Thread:
Re: where do docs fit in the development process?
Next by Thread:
Re: where do docs fit in the development process?
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads