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: Thoughts on Working With Developers (long) From:Tracy Boyington <tracy_boyington -at- OKVOTECH -dot- ORG> Date:Mon, 5 Apr 1999 15:19:10 -0500
> Technical edits may be what we need from them, but it does make me wonder what
> kind of drafts people are expecting their SMEs to read. Typos and grammatical
> errors sometimes creep into the drafts I give my SMEs. However, I try to get
> rid of them as much as possible before reviews.
> (snip)
> I'm curious, how "rough" do most people consider okay when they're giving an SME
> a document?
Our rough drafts are not that rough -- in fact, some of my co-workers
provide formatted copy for SMEs to look over (I don't; it depends on
your SME and the intricacies of your format).
My SMEs are Es in two areas -- teaching and the particular subject
matter that's being taught. So I ask them to look for mistakes or
anything that could be improved in those two areas. I tell them the
document will be edited by a copy editor and therefore they shouldn't
worry about grammar and punctuation errors, although I do ask them to
notice the spelling of technical terms. Of course, they still find
non-technical errors, which is fine. They also catch sentences that
could be more clear if they were written a different way, which is also
fine. So, what works best for me is (a) provide as clean a copy as
possible, (b) emphasize what you *want* the SMEs to catch, and (b)
consider anything else they catch as a bonus.