RE: Specifics on the too-good-to-be-true job PLUS question

Subject: RE: Specifics on the too-good-to-be-true job PLUS question
From: "Dubin, David" <David -dot- Dubin -at- sage -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 18 Jan 2006 15:53:33 -0500

When I worked at PriceWaterhouse, I did a great deal of development
documentation. The key is to document the "WHY" of things, not just the
"what" of things. Development documentation is designed to provide a
software developer (engineer) a road map for coding. Simply documenting the
design and what is supposed to happen to each element only tells part of it.
It is equally important to tell why that function/process/task/step was
selected and what it is supposed to do for the end user.


David B. Dubin, PHR
Senior Curriculum Developer
Sage Software
727-579-1111 x 3356
david -dot- dubin -at- sage -dot- com
Your business in mind.

-----Original Message-----
From: techwr-l-bounces+david -dot- dubin=sage -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+david -dot- dubin=sage -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Janice Gelb
Sent: Wednesday, January 18, 2006 3:47 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Specifics on the too-good-to-be-true job PLUS question

Bonnie Granat wrote:
> I think some of you here have a rough idea of my capabilities as a
> writer. I'm a good end-user writer, but I have no experience with software
> development documentation. I would be truly a novice -- but maybe it's
> something that a novice could pick up quickly?
> Question: Can I learn this by doing it? Is the RUP process intuitive? Am I
> just out of my league here, and should I say so upfront and not waste his
> my time on further discussion of this project?

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

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

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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Tour of Duty :)
Next by Author: RE: Do you have a hybrid job?
Previous by Thread: Re: Specifics on the too-good-to-be-true job PLUS question
Next by Thread: RE: CD-Rs vs. Store-bought CDs (WAS: Do Burned CDs Have a ShortLifeSpan?)

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

Sponsored Ads