Types of Software Documents

Subject: Types of Software Documents
From: "Susan Jelus" <susan -dot- jelus -at- daytonrcs -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 20 Feb 2002 10:54:04 -0500

I'm starting a new software documentation project. I'll be documenting
components of a server product that is designed to be a starting point for
an individually customized product. Programmers inside and outside of our
organization will need to know how it works, in detail. MIS Managers of
outside organizations will need to know about the architecture, features,
requirements, etc. And we need to provide information for Sales/Marketing
efforts, too.

I'm trying to define the documentation set for this project. I'm looking
at:

1) A Functional Specification for MIS Managers - purpose, design
2) An Implementation Specification for programmers who will be working with
it - detailed doc
3) A Sales/Marketing story - features, benefits, etc.

Does anyone out there have any standards, examples, definitions, or ideas
about how these different information needs could be defined, described, or
consolidated? Producing 3 different types of documents for one product
seems like overkill for a one-person documentation department (like mine).
But there are clearly 3 separate audiences, all with very different
information needs.

I would appreciate any thoughts you have on this. I'm on the digest.
Unless your respond to me directly, as well as to the list, there will be a
delay in my response.

Thanks very much.

Susan Jelus
Research Computer Services Inc.
Dayton, Ohio USA


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: Re: Are You A Writer?
Next by Author: MS MOS question
Previous by Thread: RE: Tech Writing & The Economy
Next by Thread: what to call that button that has an ellipse [...] on it


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

Sponsored Ads


Sponsored Ads