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.
>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
product
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) http://www.weisner.com/training/dreamweaver_help.htm 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 www.forehelp.com 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 http://www.raycomm.com/techwhirl/ for more resources and info.
