Re: how to write a program documention
This is a multi-part message in MIME format. --------------4F4F3C584895F231FC2B298C Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit oss96@batelco.com.bh wrote: > A have a set of module written in informix 4gl and it is required from me > to write a documention of each program in each module i.e program function, > tables used,procedures,etc.. > what is the best way to do this ? Is there any site to read about documentation > techniques? My basic template for SPL is: Purpose: <describe what funciton does> Input: <Arguments taken - names and meanings> Output: <What's returned - meaning of data> Exceptions: <Any exceptions thrown> Preconditions: <What's true of the environment before the function is called> Postconditions: <What's true afterwards - for database apps, usually a set of predicates with well-defined interpretations> Author: <Who wrote it, along w/ corporate e-mail> Created on: <Date> Modifications: <Date>: <Description> <Corporate copyright & Distribution notice> Most of this can be auto-generated by a good editor, e.g., emacs. Some materials, like the modifications section, can be managed through a revision control system, like RCS or PVCS. Many books on overall software engineering processes cover documentation techniques to some degree or other. Check out _Creating a Software Engineering Culture_ by Karl Wiegers for a few hints and a ton of references to the best of the SE literature. -J- --------------4F4F3C584895F231FC2B298C Content-Type: text/x-vcard; charset=us-ascii; name="vcard.vcf" Content-Transfer-Encoding: 7bit Content-Description: Card for Allen, Jay Content-Disposition: attachment; filename="vcard.vcf" begin: vcard fn: Allen, Jay n: Allen;Jay org: Auragen Communications, Inc. adr: 620 Park Avenue;;Ste. 177;Rochester;NY;14612;US email;internet: jayallen@auragen.com title: Senior Applications Developer tel;work: (716) 242-8759 tel;fax: (716) 242-???? tel;home: (716) 720-0421 x-mozilla-cpt: ;0 x-mozilla-html: TRUE end: vcard --------------4F4F3C584895F231FC2B298C--