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.
The development team should ensure that the product functions as it is
supposed to, according to whatever specifications you are adhering to.
The writer should ensure that the product is documented as it actually
functions.
Obviously, you should wind up with equal results. Not always true. Probably
rarely true, 100% of the time.
Marketing should also take a look at how you initially describe the product
so that it matches what they have been telling customers, or potential
customers.
As the writer, I have always tried to get my hands on the product, whether
it be software or hardware. If it is hardware, I try to actually do the
procedures that I am telling someone else to do. I feel that if I can do it,
I can document how it is supposed to be done. The same holds true for
software. Try to get on a system, or connect to a system, that runs the
software. Go through the procedures your users will encounter. Install the
software. Configure the software. If you do this, not only do you gain an
intimate knowledge of the product, but you may also find some things that
need to be fixed, solely because of your viewpoint of the product.
Engineers _know_ their product (or at least they should). They know the
shortcuts. Your end-users don't. They have to use what you provide to make
the product do what it is supposed to do, or what they want it to do.
-----Original Message-----
From: mark Dsouza [mailto:dino99 -at- hotmail -dot- com]
Sent: Friday, March 21, 2003 6:38 AM
To: TECHWR-L
Subject: sign-off procedure
In the organization where I am working we are establishing a sign-off for
technical accuracy. Perhaps somebody can let me know whether product
documents should be signed-off for technical accuracy and coverage of
functionality by the development team or the technical writer and why.
Best,
Mark
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
