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: Review Procedure for Documents & online Help From:John Cornellier <cornelli -at- stavanger -dot- geoquest -dot- slb -dot- com> Date:Tue, 22 Feb 2000 09:21:02 +0100
We produce scientific software. Help is written and programmed
simultaneously with the software, and in the draft stages there may be
informal reviews. Before commercialization, a team of
scientists--trained in the same discipline as our clients--formally and
systematically tests the product. Bugs, according to their nature and
severity, are resolved immediately or at a subsequent release. The help
is included in this process.
After commercialization, clients may submit SMRs (Software Modification
Requests) to a database. Issues may also be identified during training
sessions. The resolution of these issues may implicate the tech writer
(me).
> What are the various steps (or processes) you follow
> in your respective companies in order to ensure
> success (in terms of technical accuracy, etc.) in the
> review of Documentation and online Help?
