Home | Advertising Info2 USERS CURRENTLY ONLINE   
PowerASP
   Site Search Contact Us Thursday, April 18, 2024  

  Active InfoActive Info  Display List of Info MembersMemberlist  Search The InfoSearch  HelpHelp
  RegisterRegister  LoginLogin
Technology Talk
 PowerASP Code Help Area : Technology Talk
Subject Info: Documenting an ASP project A d d  -  P o s tAdd P o s t
Author
Message << Prev Info | Next Info >>
jakegnyc
Newbie
Newbie


Joined: March/31/2006
Location: United States
Online Status: Offline
Info: 2
Added: March/31/2006 at 9:43pm | IP Logged Quote jakegnyc

Dear all,

My ASP "camp management" system has grown and grown over the last few years, and I've now had to bring on a couple of extra programmers to help maintain and expand it.

However (ashamedly) we have not yet documented ANY of it, so training new programmers is very time-intensive. Plus if I was to ever leave the project would be screwed!

So I'd like to start documenting how the system works, and make it more accessable to new programmers. I don't really have money to spend on expensive software, but I'm looking for the most practical and useful approach. I was thinking about a Wiki...? Or should it just be MS Word or basic HTML files?

What are your opinions? Anything particular worked well for you?

Thanks!

Jake =)

Back to Top View jakegnyc's Profile Search for other info by jakegnyc
 
mjunior
Newbie
Newbie
Avatar

Joined: November/06/2004
Location: Brazil
Online Status: Offline
Info: 27
Added: April/01/2006 at 3:47pm | IP Logged Quote mjunior

I think you should document your scripts directly on the top (including comments describing the funtion, variables,etc..) Addicionally off corse, you can set a documentation repository (could be in or out your project rot folder..
The idea is to permit to every one who develop new tools could add their own documentation related, using the same repository, the same layout and the best of it is that anyone in your development team can add corelated info about it freely.
I use http://sourceforge.net/projects/wikipedia/ for documenting all my projects, and surely recomend it!

__________________
mjunior(dumb)
Back to Top View mjunior's Profile Search for other info by mjunior
 

If you wish to make a comment to this info you must first login
If you are not already registered you must first register

  A d d  -  P o s tAdd P o s t
Printable version Printable version

Info Jump
You cannot add new info in this area
You cannot add to info in this area
You cannot delete your info in this area
You cannot edit your info in this area
You cannot create polls in this area
You cannot vote in polls in this area

   Active Server Pages Rule The World
Contact Us  
All artwork, design & content contained in this site are Copyright © 1998 - 2024 PowerASP.com and Christopher J. Williams
Banner ads ,other site logos, etc are copyright of their respective companies.
STATS Unless otherwise noted - All Rights Reserved.

Active Server Pages asp source code database MS SQL MS Access .mdb adovbs.inc cookies calendar codes sql commands scripts asp programming tutorials iis web server components CJWSoft ASPProtect ASPBanner ASPClassifieds www.aspprotect.com, www.cjwsoft.com,www.aspclassifieds.com,www.aspphotogallery.com