RE: Programmer Reference Guide

Subject: RE: Programmer Reference Guide
From: "Michelle Coffey" <michelle -dot- coffey -at- EPSIIA -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 16 Jul 2002 11:09:54 -0500

Joel Wrote:
> 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
> -???

I have done a project like this in the past. One thing future developers
told me they found handy in my documentation was code standards. I know
code standards might sound insiginificant, but as a former coder, it can be
crucial in figuring out what someone was doing before you - especially since
standards can vary greatly between companies. Other than that, your list
looks pretty good.

Michelle Coffey

Technical Writer
EPSIIA Corporation
Another Fiserv Resource

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

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.

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: any printing experts?
Next by Author: Framemaker to Help - Any other way
Previous by Thread: Programmer Reference Guide
Next by Thread: RE: Programmer Reference Guide

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

Sponsored Ads