RE: Documentation Proposals

Subject: RE: Documentation Proposals
From: "Susan Jelus" <Susan -dot- Jelus -at- DaytonRCS -dot- Com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 14 Feb 2001 10:07:04 -0500

> -----Original Message-----
>Subject: Documentation Proposal
>From: Hamdi Mansour <hamdi_man -at- yahoo -dot- com>
>Date: Tue, 13 Feb 2001 08:09:27 -0800 (PST)
>X-Message-Number: 15

>I need your help regarding how can I compose a
>documentation proposal? What are the info that I
>should mention? what is the proper structure?

Here's an outline of a "Information Needs Analysis" I use to propose
software documentation, training, and/or online help.

I. Project Definition
- overview of what is being documented and why

II. Audience Analysis
- defines the different groups of people who need information about the

III. Delivery Options
- such as printed documents, online help, training classes, self-instruction

IV. Solutions/ Proposed Deliverables
- includes a table that lists the Deliverable, Audience, Completion Date,
and Owner

V. Outlines of the Proposed Information Products

VI. Time and Cost Estimates

VII. Dependencies
- the hardware/software tools, people, and information resources needed

VIII. Open Issues
- decisions that still need to be made

This "Needs Analysis" is used to guide discussion and decision-making about
the documentation and training needed for new software products. It is
usually just 3- 5 pages long (short). It works well for me. If you'd like
to see a finished proposal, just let me know.

Susan Jelus
Research Computer Services, Inc.
Dayton, Ohio USA

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) or 800-646-9989.

Sponsored by ForeFront, Inc., maker of ForeHelp Help authoring tools
for print, WinHelp, HTML Help, JavaHelp, and cross-platform InterHelp
See for more information and free evaluation downloads

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 for more resources and info.

Previous by Author: Re: Hiring an entry-level writer
Next by Author: Re: Document layout: Whose decision?
Previous by Thread: RE: Something new to worry about
Next by Thread: Starting a new project

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

Sponsored Ads