|
|||||||||
|
|||||||||
|
|||||||||
 |
|||||||||
| |
||
|
|
|
|
|||||||||
|
|||||||||
|
|||||||||
|
|||||||||
| |
||
|
|
|
| |||||||||
 |
|
|
«
Previous Thread
|
Next Thread
»
|
Thread Tools | Search this Thread | Rate Thread | Display Modes |
ASP Free Forums Sponsor:
|
|
|
|
#1
February 20th, 2005, 02:22 PM
|
|||
|
|||
|
documentation
just completed a project
now i need to get the documentation done any ideas on how to start? also are there any available examples of documentation like what is required the do's and donts etc etc any links help!
|
|
#2
February 20th, 2005, 04:42 PM
|
||||
|
||||
|
usually, it's better to add the documentation while writing the project, not after finishing it especially in big project - keep that in mind for the future.
 anyways, general concepts of documentation are: 1. in the beginning of any file, write the file name, description of what is its usage in the project, author name, date of creation and revision history. 2. in the beginning of any function/sub write full details about what it's doing, what parameters it expect and what it returns in case it's a function. 3. throughout all your code, put detailed explanations around specific lines and bits of code - that's the most important rule of all... also, not really documentation but giving meaningful names to variables is also vital.
|
|
#3
February 20th, 2005, 07:26 PM
|
||||
|
||||
|
Shadow wizard is right, you better comment code while programming.
And when its a very huge project i create an Help file with html Help Workshop so future programmer can search through my documentation and index and all. This way its faster for em to find what they are searching for.
__________________
----------------------------------------- You're not the center of the Universe You're just an ass in the space of time -----------------------------------------
|
|
#4
February 21st, 2005, 01:13 AM
|
|||
|
|||
|
[font=verdana,geneva,lucida,'lucida grande',arial,helvetica,sans-serif]well i do use variables that make sense
and the project that i am working one is small one so i can add in the comments even now ( i have put in a few while i was writing the code ) i also want to know how to show the whole working of the project and the way the database tables are designed in form of diagrams and the way a user would use this particular project. i want to do the documentation so that i can file it in the form of a book with explanation about why i used asp and also at the end what improvements can be made to the existing project i dint get the part of 'revision history' thanks a lot [/font]
|
|
#5
February 21st, 2005, 08:44 AM
|
||||
|
||||
|
by Revision History I mean, that whenever you're making changes to the file, add comments telling when the change was made, who made it and what for... for example:
Code:
'///////////////////////////////////////// 'Login.asp '--------- 'Original Author: John Doe 'Created: 10/02/2005 'Description: this file is responsible for user login. ' will show the login form, and once user is authorized, set session varibale. 'Revision History: '1. 15/02/2005: John Doe fixed nasty bug with single or double quotes messing the database '2. 20/02/2005: John Doe fixed the code to prevent SQL injection attacks. '///////////////////////////////////////// as for the other things you asked, we can't help you much futher - to "do the documentation so that i can file it in the form of a book" simply write it as Word Document and you can then add formt and print it, and to build the diagrams you have to use tools like Visio.
|
|
| Viewing: ASP Free Forums > Other > ASP Free Lounge > documentation |
| Thread Tools | Search this Thread |
| Display Modes | Rate This Thread |
|
|
 |
|
|
|
|
|
Del.icio.us
Digg
Google
Spurl
Blink
Furl
Simpy
Y! MyWeb
Linear Mode
