RE: Guidelines for SMEs was: Writing software documentation without the software

["Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>]

I want to thank everyone for their advice and commiseration.  I made my
case, and yesterday afternoon, the developer came and installed the
program on my box.  While not as fully functional as what they have-for
instance, they edit the Stored Procedure code in PowerBuilder 5
(yes-version 5), which I don't have, and there's no need, since we're
phasing out programs written in PB-it was enough for me to flesh out my
documentation.

I think the basic problem is that they haven't worked with a Technical
Writer in a while, which means I need to sit down and write some
guidelines for the SMEs.  They aren't unapproachable, as are many SMEs,
but I don't think they quite understand what I need from them.  The few
times I've sent them a draft, they tend to say, "Looks fine to me," or
"You might want to change this one little thing," but when I send it to
the Development Manager, I'm missing information, or a procedure
description is wrong. . .  (Exit Technical Writer, stage left, grumbling
choice Anglo-Saxon words under his breath and looking forward to the
pint of Guinness after work.)

The solution?  Let the SMEs know I need as much information as they can
give me from the outset, and I need it written down to augment my notes
and memory of their walk-through.  Also, I have to let them know I will
be sending them rough drafts, which they can edit (use a different font
color-I don't like the comments in MS Word), as well as a feedback
rubric.  Does anyone have a standard they've developed over time?  We're
hiring six new developers in Q1 of '07 (2 permanent, 4 contract), and
I'd like to have a system in place before then.  

Thanks,

RGBrasel

P.S.  Did anyone who lives farther north than the Arkansas/Missouri
border see the Aurora Borealis last night?  There was a massive Solar
Storm yesterday.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.