1.09 Dokumentation.

Præsentationer af emnet: "1.09 Dokumentation."— Præsentationens transcript:

1 1.09 Dokumentation

2 Dokumentation Dokumentation har flere formal.
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.

3 Kildekode Kildekode er den kode der bruges til at skrive programmer.
Eksempel:

4 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”

5 Hvad er dokumentation Kildekode documentation (som vist)
Kravsspecifikation. Diagrammer. Beskrivelse af use cases, klasser, API’er osv. API = Application Programming Interface

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

7 Indbygget brugerdokumentationsværktøj i Windows…Undkyld MAC brugere
PSR - Eksempel

8 Brugervejledning – DEMO
Hvordan ville jeg beskrive brugen af Google?

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