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.
Subject:Re: Have QA compile the help project? From:Kris Olberg <kjolberg -at- IX -dot- NETCOM -dot- COM> Date:Tue, 11 Nov 1997 20:33:55 -0600
-----Original Message-----
From: Lynda Straus <Lynda_Straus -at- THEMONEYSTORE -dot- COM>
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU <TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU>
Date: Tuesday, November 11, 1997 2:13 PM
Subject: Have QA compile the help project?
>I need reasons why the help author *only* should be doing the work up to
>the point of delivery. OR, if anyone is handing over a ready-to-compile
>folder (mine's 480 files, 10MG before compiling, and one file, 780KB
>after compiling) to the QA staff, please let me know, and how well does
>it work?
QA groups are frequently involved in the build process. Some QA groups take
only raw source as input and build entire projects, so I'm not surprised
that your development group has suggested the same for your help. Keep in
mind that the help is INTEGRATED with the application, which by definition
makes it a part of the application. It really shouldn't be treated
differently from other aspects.
This doesn't necessarily mean that you quit compiling source code. You still
are responsible for UNIT testing your material, which necessitates your own
compiling. By the time your stuff is ready for QA you should have it so
clean that you shouldn't be concerned if someone compiles it over again. If
the process your company uses works, then nothing should change in between
your last compile and the compile that QA uses for testing. If something
does change, then your going to be first to know about it because it's most
likely a problem in the source.
Actually, a good process should require this sort of thing. Reproducibility
with integrity is important to quality control measures. Not only can the
process be duplicated time and time again as flawlessly as possible, it
eliminates dependencies on specific persons or departments. This places the
onus on the process itself.
I certainly wouldn't worry about it. It's not a threat to you or to the work
you've done. And in the end, it will make your product better than ever. And
consider yourself lucky to be working with a QA group that has such advanced
skills.
Regards...Kris
------------------------------
kolberg -at- actamed -dot- com
kris -at- olberg -dot- com
