RE: Writing software documentation without the software

Subject: RE: Writing software documentation without the software
From: "Joyce Fetterman" <Joycef -at- gtsoftware -dot- com>
To: "Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 14 Dec 2006 12:39:07 -0500

Russell Brasel wrote:
<< The only problem is that I don't have the application on my box. I'm
finding it difficult to properly document the procedure without having
the program in front of me. Also, our programmers are incredibly busy,
so I don't feel that I can have them show me the process every time I
have a question.>>


Been there, done that, got the T-shirt -- many times.

I'd write it up as best as possible from the notes, and then add mark-up
indicating my unresolved questions. I'd then either send the draft to
the SMEs for review and comment, or send them an e-mail listing the
questions. Another possibility is to schedule a meeting with the SMEs
after you've written as much as you can and bring all of your questions
to the table.

==> Interrupt the SMEs as little as possible and make the most of the
time you get with them.

==> Keep your boss informed about what's happening.

It's certainly not my favorite way to work, but it happens and you can
manage it.

Joyce
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


Follow-Ups:

References:
Writing software documentation without the software: From: Brasel, Russell

Previous by Author: RE: Style Guide examples
Next by Author: Copyediting Eclipse cheat sheets?
Previous by Thread: Re: Writing software documentation without the software
Next by Thread: RE: Writing software documentation without the software


What this post helpful? Share it with friends and colleagues:


Sponsored Ads