RE: Source Code documentation?

Subject: RE: Source Code documentation?
From: "Gilger.John" <JGilger -at- acresgaming -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 11 Apr 2001 07:53:01 -0700


1. Read a module of the source code.
2. Write a clear concise explanation of what it does. Make this explanation
simple enough that your aged grand-mother can understand it.
3. Repeat steps 1 and 2 till all code is explained.
4. Revise and edit into a coherent document.

John Gilger
Senior Technical Writer
Acres Gaming, Inc.

-----Original Message-----
From: SATISH RAJ H [mailto:satishraj -dot- h -at- lycos -dot- com]
Sent: Tuesday, April 10, 2001 11:33 PM
Subject: Source Code documentation?

My organization requires me to do source code documentation in Delphi.
I would be eternally grateful if you folks could advise me on how to go
about with it. I have of course heard of tools - Time to Help etc.
What I need is methodologies / strategies.
Is there any web site which give such info?
My thanks in advance.


*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at or info -at- devahelp -dot- com

Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27.

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: Whaddaya know? (long)
Next by Author: RE: Tech Writer Ethics: Yahoo Enters Porn Business
Previous by Thread: Source Code documentation?
Next by Thread: Re: Source Code documentation?

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

Sponsored Ads