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.
Do you think it would matter? You're asking the vendor to rewrite the
documentation that you are getting. Question.: assuming you have multiple
customers for your product, and one of them comes to you telling you to
rewrite your hundreds of pages of documentation to suit their requirements.
Would you just for one of them? And if another customer had their
requirements, would you rewrite the docs again to suit them?
If the documentation is that bad, tell your company to switch
vendors...chances are they won't.
Now...they may take your suggestions under advisement and maybe integrate
the suggestions into a future release, but don't expect that you submit a
style guide and the return documentation based on it.
John Posada
Senior Technical Writer
john -at- tdandw -dot- com
----- Original Message -----
From: "mark Dsouza" <dino99 -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Friday, March 14, 2003 10:50 PM
Subject: documentation checklist or style guide
>
> I work in an organization where a vendor supplies the user manuals to the
> customer support department. Due to the declining quality levels of the
user
> documentation supplied. I was thinking about setting some standards for
the
> vendor supplied documentation. Do you think a 2 page documentation
checklist
> would be more useful than a 30 page style guide? Any suggestions?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here: http://www.ehelp.com/techwr-l
Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....
---
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.
