Dokumentation af IT-projekt - skabeloner?

Hej med-aminoer!

Jeg er i gang med et hobby-projekt med en hjemmeside som til sidst skulle ende ud i et stort system med mange funktionaliteter. Pt er jeg ene om arbejdet, men det kan ske teamet bliver udvidet senere hen.

Min tanke gik på at store IT-systemet jo altid har stor fordel af en gennemført dokumentation af alt lige fra projektbeskrivelse over valg af variabel-navne, skrifttyper og farver og til beskrivelse af moduler og grænseflader. Projektet er i en meget tidlig fase og jeg tænkte det ville være en god øvelse til fremtidigt arbejde at prøve at lave noget gennemført dokumentation på mit hobby-projekt. Også så jeg ikke glemmer fra gang til gang om jeg bruger CamelCase eller underscore til variabler, og så en anden også har mulighed for at hjælpe med projektet senere.

Men! Ja, der er jo altid et men ;-) jeg har lidt problemer med at komme igang... Jeg har søgt lidt rundt på nettet efter en slags "skabelon" til det, men ikke fundet så meget som jeg håbede. Jeg har lavet den helt generelle projektbeskrivelse med krav, funktionalitet, målgruppe, succeskriterier osv. men mangler lidt et startskud til at dokumentere mere kodespecifikke eller designspecifikke valg i løbet af projektet. Samt også meget gerne lidt inspiration hvordan man på en overskuelig måde kan dokumentere moduler og grænseflader så jeg senere kan skifte et helt modul ud uden at rode i resten af koden, hvis det bliver nødvendigt.

Alle gode råd er meget velkomne :)

-Randi
Dokumentation - skabeloner søges?

Den helt store, forkromede dokumentation har du nok først behov for, når der kommer andre programmører ind over, eller projektet er vokset dig over hovedet. Mit råd vil være at have en grundlæggende ide om, hvad du vil, og så gå i gang. Hvis du sætter et kæmpe dokumentationsapparat i gang, kommer du sandsynligvis til at bruge utroligt lang tid på at opdatere det, fordi nye projekter ofte ændrer sig meget.

Lav en simpel version af dit projekt, se, hvordan brugerne tager imod det, lav om, byg videre, og skriv så dokumentationen efter nogen tid.

Jeg siger ikke, at dokumentation eller planlægning er en dårlig ide, men alt med måde. Planlægningsmæssigt bør du bruge meget mere tid på at lave brugerfladen i detaljer (før du programmerer den bagvedliggende kode) end at dokumentere koden. Lav evt. et HTML-mockup, som dine brugere kan teste, før du overhovedet laver koden bag.

Lundsby - tak for link, det må jeg lige se at få kigget på :)

Jonas - det projekt jeg er igang med har allerede eksisteret i både version 1, 2 og 3 og version 4s design er blevet brugt af nogle brugere allerede, da version 4 kun blev halvt færdigt før jeg besluttede at det skulle laves om helt fra bunden igen bruges samme design til version 4.5.

Allerede på nuværende tidspunkt ved jeg at mange af funktionerne skal være rimelig avancerede, men første udkast bliver kun med de helt basale funktioner, hvorefter jeg har tænkt mig gradvist at udbygge med de mere avancerede funktioner til de forskellige moduler. Det kan godt ske jeg skal nøjes med at kradse nogle simple ting ned til første udkast, så jeg selv har styr på hvad jeg nu beslutter undervejs, og så se nærmere på en mere udvidet dokumentation senere.