Re: Source Code documentation?

Subject: Re: Source Code documentation?
From: "Leslie Peet" <lpeet -at- fimat -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 11 Apr 2001 10:39:47 -0500

While I was still working as a programmer, I volunteered to document
source code (AS/400; RPG 400) the client had bought from a third-party.

Since the code produced reports, I began with shots of the screen that
allowed the user to enter parameters for the report, described the flow of
data through the code, provided a list of all the fields in the report and
how the values were calculated, and a list of all the called programs and
files used or created. I don't know who the audience for your
documentation is; I was producing the documentation for the rest of my
team, since we were supposed to maintain this code, and for the client who
wanted technical information.

I hope this helps.

Leslie Peet
Documentation Specialist
Fimat Facilities Management, Inc.
Chicago, Illinois USA
lpeet -at- fimat -dot- com

"SATISH RAJ H" <satishraj -dot- h -at- lycos -dot- com> on 04/11/2001

Please respond to "SATISH RAJ H" <satishraj -dot- h -at- lycos -dot- com>

Sent by: bounce-techwr-l-58764 -at- lists -dot- raycomm -dot- com

To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>

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: techwr-l digest: April 18, 2001
Next by Author: RE: Business cards
Previous by Thread: RE: Source Code documentation?
Next by Thread: Re: Source Code documentation?

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

Sponsored Ads