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: Tech Writing Problems From:Caryn Rizell <caryn -at- HPPTC95 -dot- ROSE -dot- HP -dot- COM> Date:Wed, 1 Mar 1995 08:56:06 PST
Lori:
I think you are going to need a face-to-face meeting with the
programmer to go over the document. In my experience, it
is a lot easier to get comments in person rather than on
paper.
As a thread about SME's mentioned a while back, programmers
and programmer types don't like to write. It is much easier
for them to verbalize than to communicate in writing.
So, I would suggest you set up an appointment and make
the 100 mile drive or arrange for a telephone conversation.
You might want to couch it in the terms "I have a few questions
and need your advice", rather than "Could you review
this document?"
Just some thoughts.
Caryn Rizell
caryn -at- hpptc95 -dot- rose -dot- hp -dot- com
> I'm writing a user's guide for a software product that's being developed
> for a government agency. The development team is small: one programmer,
> one SME, the contract manager, and me. The programmer and I both live in
> Colorado, but we're separated by about 100 miles (and the Continental
> Divide!); the SME and the contract manager are in DC. If you've already
> guessed that the problem has something to do with communication, you're
> right.
> The problem: getting the programmer to answer the questions in my first
> draft. I made my questions as conspicuous as possible; they are
> sprinkled throughout the text in thick-lined boxes and the words
> "DEVELOPMENT NOTES" centered on the first line of each box). When I gave
> him a call today (after not hearing from him since giving him the draft
> two weeks ago), his response to my request for feedback was, "Oh, it's
> great! Just what we needed!" I then asked him if he could respond to the
> questions I'd written as DEVELOPMENT NOTES throughout the draft. His
> response was, "Ah, well, um, questions? Can I call you back tomorrow?"
> I'd be willing to bet my bottom dollar that he won't call me back
> tomorrow.
> I *will* get him to provide the answers I need; however, I'll probably
> have to get the contract manager to rattle his cage. I hate having to
> resort to that strategy, even tho' it's an effective one.
> There! I feel better now with that off my chest ....
> *************************************************************************
> Lori Lathrop ----------> INTERNET:76620 -dot- 456 -at- compuserve -dot- com
> Lathrop Media Services, P.O. Box 808, Georgetown, CO 80444
> (Author of _An Indexer's Guide to the Internet_, published by the
> American Society of Indexers, P.O. Box 386, Port Aransas, TX 78383)
> *************************************************************************