Jeg begyndte for få dage siden at dokumentere Kilenna’s Dragons projektet i nærmere detaljer, da jeg tænkte det ville være en god øvelse til fremtidige projekter. Det første store spørgsmål dukkede naturligvis hurtigt op. Hvordan er det egentlig hensigtsmæssigt at dokumentere? Findes der mon nogle skabeloner derude til god projektdokumentation til hjemmesider?
Jeg har søgt vidt og bredt, og fundet lidt omkring forberedelse af et projekt. Beskrivelse af målgruppe, formål, succes-kriterier, konkurrenter og ansvarlige personer. Det er mundet ud i 4 siders indledende tekst om hvad projektet skal være og hvordan. Men der skal jo også beskrives moduler og grænseflader og des lige, men hvordan gør man bedst det? Hvis nogen har en god skabelon eller blot input/idéer så vil jeg meget gerne høre om dem.
Jeg kender godt nok ikke til det projekt du snakker om, men som udgangspunkt er det altid smart at dokumentere sin kode og database.
Koden kan dokumenteres gennem:
Klasse diagrammer
Flow diagrammer
osv
Databasen bør som udgangspunkt dokumenteres med:
ER / EER diagrammer
Normalisering
funktionelle afhængigheder