Debat
|
Hej. Hvordan dokumenterer man et website, og hvad skal der med i sådan en dokumentation af et website ?? Jeg tænker på hvis man har et website man vil sælge, og der så skal følge en dokumentation med . |
Hej Sennid Ja, hører nogle gange at et website skal være ordentlig dokumenteret, men hvad der menes ved jeg ikke.. Der må være nogle professionelle programmører der kan svare på det ?? |
|
Med dokumentering menes der sikkert dokumentation af sourcecode. Dvs. kommentare til de vigtige brudstykker af din sourcecode, så de nye programmører nemt og hurtigt kan gå ind og rette/udvikle sitet, uden at skulle igang med at gætte og lede i koden. |
|
Kunne da godt tænke mig at se eksempler på dette, og er der evt en standard indenfor dette ?? |
|
Jeg har engang dokumenteret en webbaseret service jeg udviklede for en kunde, og dokumentationen indeholdte følgende:
mvh Carsten
|
|
Det ville være naturligt at lave et designklassediagram (gaaaab) og evt. sekvensdiagrammer over evt. større/komplicerede transaktioner. Der findes standarder til at dokumentere sin kode, men du behøver jo ikke dokumentere det i bund. Du kan se et eksempel her: http://java.sun.com/blueprints/guidelines/designing_enterprise_applications_2e/images/app-archa4.gif (beklager, jeg ikke lavede direkte link - det kørte ikke rigtigt for Amino). Evt. andre kommentarer kan du, som Carsten skriver, blot skrive ned i klar tekst. Evt. også hvorfor du har valgt de valgte løsninger, hvis det ikke er indlysende.
|
Bliv gratis medlem
Opret bruger