[ASP] Website documenteren?

[ArchRAIDen]

Ok, ik zit nu met het volgende:

Ik heb een site gemaakt, hoop .ASP pagina's.

Nu zit ik alleen een beetje met het documenteren
van die pagina's, ik had al een opzet gemaakt,
maar vroeg me toch af of het wel de juiste manier
is. Wat ik nu doe is voor elke .ASP pagina
een apart documentje maken, hier staat dan
ongeveer het volgende in:

- omschrijving
- opbouw
- functies die gebruikt worden
- database + tabelnamen en kolommen
- en een algehele uitleg van de code
die in dat bestand staat.

Ben ik nu goed bezig of hebben jullie nog andere ideeen

[dusty]

Op woensdag 06 maart 2002 08:54 schreef ArchRAIDen het volgende:
- omschrijving
- opbouw
- functies die gebruikt worden
- database + tabelnamen en kolommen
- en een algehele uitleg van de code
die in dat bestand staat.

- Omschrijving, Wat doet het, Waarom?

- Welke functies zijn in deze ASP zelf gedeclareerd, welke parameters en waar zijn deze parameters voor, welke parameters worden van inhoud veranderd als ze meegegeven worden, welke worden niet veranderd. Wat zijn de pre- en post- condities voor deze functies?

- Database + tabelnamen en kolommen -> Overbodig, Dit moet compleet in een aparte documentatie, specifiek van de database model waar je alles kan uitleggen hoe de database in elkaar steekt.

- Algehele uitleg lijkt mij overbodig, aangezien je alleen hoeft te weten wat het doet, de moeilijke gedeelten van de code zou je kunnen documenteren.

Wat ik nu mis is onder andere welke files worden gebruikt?

Naar welke pagina's wordt er verwezen (doorverwezen), via welke pagina's kunnen ze er komen.

Uiteraard doe je dit ook voor de ASP bestanden met globale functies die je in verschillende ASP's gebruikt.

Je bent in iedergeval op weg om een uitgebreide documentatie te maken!