07. juli 2005 - 09:06Der er
7 kommentarer og 1 løsning
Dokumentation af software
Hej
Jeg søger information (bøger, artikler, hjemmesider, o.a.) på hvordan man laver en god software dokumentation, som kan beskrive analyse, design og funktionalitet m.m
Teknologi, AI og forretning er i centrum på Computerworlds Cloud og AI Festival i København d. 18. og 19. september. Se hele programmet for den store konference om strategisk brug af Cloud og AI på: www.cloud-festival.dk
Det er ikke nemt at give en sikker opskrift på god dokumentation. Forskellige udviklings metodikker defigerer forskellige dokumenter som skal laves i processen. men der er ikke enighed om hvad der er den bedste metodik. Og selvom man vidste det, så beskriver de kun hvad der skal laves ikke hvordan det laves på en god måde.
Efter min mening er hemmeligheden ved god dokumentation at beskrive det som er vigtigt og det som ikke er indlysende. Det lyder banalt, men tror mig - ikke al dokumentation følger den simple regel.
Når du skriver dokumentation så prøv og tænk i banerne: hvis jeg var maintenance programmør og fik til opgave at fixe en bug eller tilføje en feature i dette software uden at have været med til at lave det oprindeligt, hvilke oplysninger ville jeg så finde det rart at have.
Værktøjer: tekstbehandling f.eks. Word generelt diagram værktøj f.eks. Visio specielt UML værktøj
Tilladte BB-code-tags: [b]fed[/b] [i]kursiv[/i] [u]understreget[/u] Web- og emailadresser omdannes automatisk til links. Der sættes "nofollow" på alle links.