RE: Programmer Reference Guide

Subject: RE: Programmer Reference Guide
From: "Richard Smith" <richard -dot- smith -at- windriver -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 16 Jul 2002 09:34:45 -0700

In a survey my present company did a few years ago, the doc components that
developers liked the most (things a product doc must have) were system
architecture docs, complete reference docs, and tested working sample code
for each feature (in that order, by the way).

Models can be very useful, especially if they are based on a modeling
standard like the UML.

The only other thing I can add is that developers tend to expect good
release notes. Many developers I've spoken to want release notes that
include EVERY change, no matter how trivial the change or how big the
release notes get.


> They want a guide that a future developer can pick up,
> read and get an understanding of how the system works.
> He/She should then be able to get down and dirty and
> modify or add functionality. Nobody seems to be really
> sure as to what is necessary in this document.
> My thoughts are:
> -Data Model
> -Data Dictionary
> -Process Flow Charts
> -System Architecture
> -???

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Save $600: Create great-looking Help files and software demos with
RoboHelp Deluxe. Get RoboHelp and RoboDemo - our new demo software - for one
low price. OR Save $100 on RoboHelp Office in June with our mail-in rebate.
Go to
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.

Programmer Reference Guide: From: Joel Vaillancourt

Previous by Author: RE: Average Hours Worked
Next by Author: RE: Cross-browser help for Netscape, IE, and Opera?
Previous by Thread: RE: Programmer Reference Guide
Next by Thread: RE: Programmer Reference Guide

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

Sponsored Ads