RE: Programmer Reference Guide

Subject: RE: Programmer Reference Guide
From: "Dick Margulis " <margulis -at- mail -dot- fiam -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 16 Jul 2002 12:23:59 -0400

One thing I'd add that I haven't seen mentioned so far: an overview that says what this beast does, how it does it, and what each of the component parts is responsible for, in descriptive prose (in conjunction with a flowchart, of course). In hardware this is called the Theory of Operation. Maybe there's a standard name for something like that in software, too; but the it's escaping me at the moment.

It's great to have an idea of what all these various pieces do and how they relate to each other before trying to modify, maintain, or redesign the thing.

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.

Previous by Author: Re: Author Credit
Next by Author: RE: Author Credit
Previous by Thread: RE: Programmer Reference Guide
Next by Thread: Re: pictures vs. words

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

Sponsored Ads

Sponsored Ads