[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Writing software documentation without the software

Subject: Re: Writing software documentation without the software
From: "Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com>
To: "Brasel, Russell" <russell -dot- brasel -at- hccredit -dot- com>
Date: Thu, 14 Dec 2006 12:31:43 -0500

Hi:

I have been in the same situation here. One of our people sends me screen
shots and quick notes, and I document from that. The software is
shrink-wrapped, but customizable by the business, which is what we did.

Generally, I will write as much as I can with what they give me, and put in
bunches of questions (like, "what happens now? Do they... or do they... or
"step missing" or "what does this do" and so on). I have told my supervisor
that I can't document what I can't see...I finally did get access, but just
because I asked so many questions in the procedure steps. They finally
decided it was just easier to give me "test access" instead of addressing my
million questions. :-)

I am still not allowed to ask the subject matter expert any questions
though. Everything goes through a non-technical person who does not
necessarily understand the software. It's frustrating, I know.

Usually, I just say that I will do the best I can without being able to see
the software, but I can't agree to be responsible for the content if I
cannot verify what I am writing about. In other words, "don't look at me if
it's wrong."

Good luck :-)
PT


On 12/14/06, Brasel, Russell <russell -dot- brasel -at- hccredit -dot- com> wrote:


Has anyone here had an experience like this?

We have a small application that the programmers use to run Stored
Procedures on our accounts. On Monday, one of our programmers showed me
how they use the application-I took notes, got a screenshot, and started
writing my documentation. 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.

I've informed my manager that trying to write software documentation
without the software is like writing a cookbook without testing the
recipes. He hasn't gotten back to me yet, and I need some advice about
making my case. I'm sure I'll be called for a meeting this afternoon.

RGBrasel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 pro -dot- techwriter -at- gmail -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/pro.techwriter%40gmail.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.




--
PT
pro -dot- techwriter -at- gmail -dot- com
I'm a Technical Technical Writer!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.

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

Previous by Author: Re: Writing Test
Next by Author: Re: Writing Test
Previous by Thread: Writing software documentation without the software
Next by Thread: RE: Writing software documentation without the software

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads