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.
> Rowena wrote:
> I'm wondering: How many of you actually work with
> editors who check facts as well as writing? At what
> point in the development cycle does the editor start
> checking facts? How long does it take them, compared
> to checking writing? And how well does it work? For
> example, how much additional fact checking is required
> before the documents go out the door?
I'm not sure exactly what you mean by fact-checking, I assume it's the
technical accuracy (what the publication describes matches what the spec.
says and what the product actual does). And, I think you might avoid the
"additional fact checking" if you monitor those development cycle milestones
that effect your publications.
Although each company treats the development cycle in different ways (from
very detailed to nonexistent), you'll want to key in on certain milestones
and delivery dates: requirements; function/feature freeze (by
module/functional area, particularly for short dev. cycles) & UI freeze
dates -- so you can plan when you'll be ready for the 'fact-checking'
> Requirements exist, but will probably be left untouched in a dusty
> network folder once the project really gets underway.
Just to clarify, by "Requirements" are you referring to the Marketing or
Products Requirement document? (In my experience, both are created prior to
and supplanted by the Product Specification. -- "your mileage may differ"
>Since I started technical writing, fact checking has
>always been taken care of by quality assurance testers....<snip>
>I'm wondering: How many of you actually work with
> editors who check facts as well as writing?
During 15 years of writing, I've never worked with a full-time editor
(writers also have done the editing). Frankly, in my opinion, whoever edits
the documents, whether for technical accuracy (by QA/SME), adherence to the
style guide, basic/comprehesive editing, I, as the author, bear the
responsibility for the accuracy (or lack of it) in the pub.
Hope this helps you,
Last chance to order RoboHelp X3 and receive a $100 mail-in rebate,
PLUS free RoboScreenCapture and WebHelp Merge Module. Offer expires
4/30/03! Order here: http://www.ehelp.com/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.