Dokumentation
Sk%C3%A6rmbillede%202019-12-11%2007.10.00.png

Dokumentation

At dokumentere vil sige at beskrive sit system, både internt og eksternt.

Du er it-leder i en virksomhed/offentlig institution, der har et stort it-system til behandling af både kunder, sager og løn. Det har
hidtidigt kørt godt og det har været let at oplære nye medarbejdere, for den programmør, der skabte systemet for 25 år siden heldigvis > også var dygtig til at skrive brugervejledninger og kursus-materialer. Nu holder systemet imidlertidigt op med at virke og personen, der > skabte systemet er forlængst gået på pension. Hvad gør du?

Typer af dokumentation

Overordnet kan man skelne mellem

  • Intern dokumentation - skabt for udvikler-teamet, fx teknisk dokumentation, når man senere skal vedligeholde systemet.
  • Ekstern dokumentation - skabt for aftagerne, dvs. brugerne, når de skal anvende systemet.

Andre typer dokumentation

  • Brugervejledning
  • Kode-noter
  • Flowcharts
  • Brugervenlighedstest
  • Teknisk vejledning
  • Bruger-scenarier/use-cases
  • Systembeskrivelse
  • Sitemaps
  • Mindmap
  • Spørgeskemaer
  • Kravspecifikation
  • Blok-diagram
  • grænseflade-diagram
  • Vedligeholdelsesplan

Se video om dokumentationstyper i i Arduino-projekt her
Quiz om dokumentationsformer her

Hvorfor dokumentere?

Hvordan dokumentere?

Links

Medmindre andet er angivet, er indholdet af denne side licenseret under Creative Commons Attribution-NonCommercial 3.0 License