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.
This is just my experience, but the most sucessful software dev environments
I've worked in as a software documentor were ones in which QA testing and
documentation were literally best freinds. I depended heavily on the testers
to go through my documentation and test it with a distance you lose when you
are writing a doc. Testers often come up with a better way to word something
when communicating a piece of highly technical information; they can also
provide lots of valuable input into the structure of your manual; for
example, maybe section 3 would be better placed before section 2 because the
user needs that information first. Testers and writers can also work
together to be a good advocate for the end user; on one project I worked on
the testers and I ganged up and lobbied to have some system admin tools
added to the product.
If anyone is interested, I have put together a QA Tester's checklist of
things to look for when reviewing software documentation. I put it together
as part of a workshop I did with a QA group in which we educated them on
what their documentation testing role was and how to work with us. If anyone
wants a copy of the checklist, just email me. I certainly owe this list a
lot in terms of valuable advice and info!
Regards,
Cara O'Sullivan
Documentation Writer
QA Testing & Deployment Group
Global Software Development, P&T
Modus Media - Lindon, Utah
Ph. (801) 431-8550
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at 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.
