Saneesh wrote:
>Recently I completed a project that was done using SERVLETS.
>
>I need some help in documenting the application. What is the standard
>way or methods in documenting?
Since noone else seems to be offering information forward, I'll reply. Our
team is in a similar position, the frontend we have developed for a client
is 98% complete, the back end is 70% complete, and the database supporting
them is long finalized. We are coming into a phase of documentation to get
the project signed off.
The documentation of the project includes each contact with the client (
down to the hour ) and each Out Of Scope item requested ( and time it took
to implement or reject ). There are logs also of practically every decision
made ( technical, design, and implementation ) and why.
On the coding side, the scope includes the client receiving the source code
and source documentation. For the Servlet aspect of that they will be
getting the source as paper printouts of java files plus the javadocs output
of the project on CDROM. The technical and design discussions/logs of this
aspect of the project are presented as cover sheets to these sections.
Dont know if that helps or not, or if anyone has better ways of
documenting/presenting a project so it gets signed off.
Cameron Riley
Edwards and Kelcey
www.ekwireless.com
www.ekcorp.com
Tel. 973 267 8830 ext 1265
Fax. 973 267 3555
Email. [EMAIL PROTECTED]
___________________________________________________________________________
To unsubscribe, send email to [EMAIL PROTECTED] and include in the body
of the message "signoff SERVLET-INTEREST".
Archives: http://archives.java.sun.com/archives/servlet-interest.html
Resources: http://java.sun.com/products/servlet/external-resources.html
LISTSERV Help: http://www.lsoft.com/manuals/user/user.html
