1.09 Dokumentation

Dokumentation Dokumentation har flere formål. Det beskriver hvordan systemet virker. Det forklarer hvordan systemet lever op til kravene. Det hjælper nye udviklere med at finde ud af hvordan systemet virker. Det hjælper også dem, der lavede det, med at huske hvordan det blev skruet sammen. Dokumentation som primært udviklerne skal bruge for at udvikle.

Kildekode Kildekode er den kode der bruges til at skrive programmer. Eksempel: HTL ( man markerer noget op på en speciel måde) Kildekode hvor der bliver brugt taggs (orange)

Dokumentation I koden Man kan bruge kommentarer til at dokumentere hvad der sker inde I koden. Dette gør det nemmere at se hvad noget specifikt kode gør. Kommentarerne bliver ikke “afviklet” Kommentarer (grøn) Css bruges til at hente et style sheet, der får det til at se pænt ud på f.eks. En hjemmeside

Hvad er dokumentation Kildekode documentation (som vist) Kravsspecifikation. Diagrammer. Beskrivelse af use cases, klasser, API’er osv. API = Application Programming Interface Dokumentation i forhold til udvikleren. API: man har lavet et program, som andre skal kunne benytte. API er reglerne for hvad andre kan brug programmet til. API er en ”ordbog” til andre programmer. API er når et program går ind og taler med et andet program. Eksempelvis kan du med et API få din webshop til at integrere med dit online regnskabssystem. API hjælper med at overføre salg, der er lavet i webshoppen og gør at regnskabsprogrammet modtager oplysningerne, så du nemt kan bogføre dem. API fungere som et anti-virus program, hvor man kan downloade en gratis version. Her giver API´en lov til at hente den gratis version. Skal man have det udvidet anti-virus program, skal man betale for det. Først når man har betalt, tillader API´en dig, at hente den udvidet version.

Brugervejledning Ikke teknisk. Beskriver hvordan systemet bruges. En manual er en brugervejledning. Ikke alle brugervejledninger er nødvendigvis manualer.

Indbygget brugerdokumentationsværktøj i Windows…Undskyld MAC brugere PSR - Eksempel PSR er et værktøj på computeren, der optager billede for billede, hvad du foretager dig. Den kan bruges til hvis man vil en lave en guide til noget bestemt, eller skal huske/dokumentere hvordan man kom frem til en bestemt side. Man kan tilføje kommentarer undervejs.

Brugervejledning – DEMO Hvordan ville jeg beskrive brugen af Google? Ved brug af PSR

Brugervejledning - Opgave Find et program du bruger ofte. Vælg én eller to funktioner og beskriv dem skridt for skridt. Tilføj evt. billeder.