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.
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
Bonnie,
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
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
technical
> 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
or
> 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! http://www.webworks.com/techwr-l