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.
Re: Getting more than nits from reviews? (take II)
Subject:Re: Getting more than nits from reviews? (take II) From:"Susan Hogarth" <hogarth -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 23 May 2007 10:51:47 -0400
On 5/23/07, Geoff Hart <ghart -at- videotron -dot- ca> wrote:
> ...
> Seriously? Yes, you should copyedit. Never submit anything other than
> your best work. Reviewers won't respect you if you send them junk,
> and if you make their life harder than necessary, you'll get lousy
> reviews. Think of this as a law of nature, like the fact that gravity
> points downward most days <g>, and you'll find it easier to accept.
>
> If you've done your homework (i.e., you have interviewed the SMEs to
> learn the details of the process you're documenting and have
> carefully checked these details against the actual interface), they
> shouldn't be rewriting _anything_. The ideal review comment is
> "Perfect... no changes!" In the real world, that never happens, but
> that's the direction you should be aiming.
OK, I am properly raked-over-the-coals. However, I haven't presented
it exactly right. These are more team members than SMEs - THEY have
done the writing. They send it to me. I knit the pieces together
loosely. My boss says "They need more details" (he always says that)
and I ask them to provide more details. They may be doing an entire
re-write at this stage. Still copyedit?
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-