Invoering
Ontwikkelen gebruikersdocumentatie

Beheer Na afloop van het systeemontwikkelproject worden de eindproducten veelal overgedragen aan een beheersorganisatie. Om de applicatie te kunnen beheren wordt nu meer aandacht besteed aan het opleveren van documentatie en code.

Het schrijven van gebruikersdocumentatie behoort niet altijd tot de taken van een systeemontwikkelproject. Veelal gebeurt dit achteraf, evenals het ontwikkelen van de opleidingen voor de gebruikers.

Samrt geeft daarom slechts een voorbeeld voor het ontwikkelen van gebruikersdocumentatie.

Doel

Het opstellen van gebruikersdocumentatie en het ontwikkelen van opleidingen voor gebruikers.

Stappen

1. Beschrijven actoren
   Voor het opstellen van gebruikersdocumentatie worden de actors centraal gesteld. Inventariseer per actor de werkprocessen, en ga na welke use case diagrammen deze werkprocessen implementeren. Beschrijf in een eerste hoofdstuk kort de verschillende actors. Gebruik hierbij de actor catalogus.
   
   
2. Beschrijven use case diagrammen
   Voor ieder van de use case diagrammen wordt een hoofdstuk in de gebruikersdocumentatie beschreven. Beschrijf in ieder van deze hoofdstukken kort het werkproces dat wordt geïmplementeerd door het use case model. Neem een afbeelding op van het use case model. Beschrijf de rol die de verschillende betrokken actors hebben in dit model.
   
   
3. Beschrijven patronen navigatie
   Creëer een hoofdstuk waarin aan de gebruikers wordt uitgelegd hoe de navigatie is geïmplementeerd. Gebruik hierbij zoveel mogelijk de in het project aanwezige richtlijnen voor de user interface.
   
   
4. Beschrijven navigatie
   Belangrijk is ook de navigatie tussen de verschillende schermen en webpagina's. Neem een afbeelding op van het user interface diagram. Beschrijf hierbij hoe de navigatie tussen de verschillende schermen en webpagina's verloopt.
   
   
5. Beschrijven forms
   Maak een afbeelding van ieder van de schermen en webpagina's op het user interface diagram. Maak een paragraaf voor ieder van deze schermen en webpagina's. Neem de afbeelding hierbij op. Beschrijf de attributen, defaultwaarden en validaties op het scherm of webpagina, aan de hand van het user interface model.
   Beschrijf bij ieder scherm en webpagina ook de bijbehorende administratieve procedures.
   
   
6. Genereren documentatie
   Genereer het gewenste uitvoerformaat voor de documentatie. Vaak zal dit ofwel een Word-document zijn, ofwel HTML (of XML).
   
   

Richtlijnen

Het is niet vreemd om een afbeelding van een use case model op te nemen in de gebruikersdocumentatie. Immers, de diagrammen zijn eenvoudig en voor vrijwel iedereen leesbaar. Bovendien zijn de diagrammen opgesteld in samenwerking met de gebruikersvertegenwoordiger.