I’ve been tasked with Documenting the Source-Code of an application that I've been working on for the last year (VB.Net in Visual Studio 2010), and I was wondering if someone could please give me a touch of guidance as how best to do it?
I’ve started with a MindMap… which shows all the files (.aspx, etc.) and /folders… and then I’ve added notes to some of them (so far), like:
Default page that runs at application start
Checks for and initiates AutoLogins
Builds "Static Pages" from the "Pages" table of the DB
"Cleans" the /temp folder on application run, once a day...
The purpose of the document is that in the unlikely event that I get hit by a meteorite, that my partners will be able to take the code, and this document, to another developer, who should then be able to easily figure his/her way through the code to continue with maintenance and development.
1. Is the way I’m doing it “okay”? Or is there a better (more standard) way to do this?
2. Would you by any chance have a document that I could look at as an example?
3. Is there a way to automagically create a document like this from Visual Studio?
Another piece of the document will be to record changes / bug-fixes as and when they occur…