Programmer Reference Guide

Subject: Programmer Reference Guide
From: Joel Vaillancourt <tke71709 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 16 Jul 2002 08:50:17 -0700 (PDT)

Hi all,

Checked the archives to no avail so I am posting here.


New Contract where I have to develop the following:
User Guide
Online Help
Training Materials
Programmers Reference Guide

We are developing a custom system that will be
delivered to the client and they will support,
maintain and functionality to it.


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

If anyone has any thoughts/experience with this type
of document I would REALLY appreciate any assistance
you could provide (tips, websites, books).

Please cc me directly as I receive the digest and I
will post a summary of the responses here.


Do You Yahoo!?
Yahoo! Autos - Get free new car price quotes

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.


Previous by Author: Re: Caitalization of Web Services
Next by Author: Re: framemaker TOC page number questions
Previous by Thread: Re: Word95 template conversion problem
Next by Thread: RE: Programmer Reference Guide

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

Sponsored Ads