OsirisOsiris1. Algemene werkinstructies Screensteps1.0 Uitgangspunten schrijven werkinstructies

1.0 Uitgangspunten schrijven werkinstructies

Doel: In deze instructie staan de uitgangspunten beschreven die worden gehanteerd bij het schrijven van werkinstructies voor Osiris met Screensteps.

Voor wie: Voor de key users die deze werkinstructies zullen maken.

Privacy gegevens

Daar waar student- of docentgegevens worden getoond in een printscreen, moeten deze worden "geblurd" zodat deze niet zichtbaar zijn. Daarmee wordt de privacy van de personen die in de gegevens voorkomen gegarandeerd.

Screenshots

Screenshots

Bij het maken van screenshots wordt zoveel mogelijk de groene Osiris bovenbalk gebruikt, zodat een gebruiker snel een overzicht heeft van waar in het scherm hij zich bevindt.

Autorisatie informatie

In elke werkinstructie wordt aangegeven voor wie de instructie is bedoeld. Zo kan een lezer direct zien of de werkinstructie voor hem of haar van toepassing is.

Onderwerpen van de werkinstructies

De onderwerpen die in de werkinstructies worden beschreven zullen zoveel mogelijk in de vraagvorm worden gesteld. Daarmee kan de gebruiker in de index uiteindelijk eenvoudig zoeken naar relevante informatie en het stelt de schrijver in staat om een goede begrenzing aan zijn werkinstructie te geven.

Tweetalig

De werkinstructies voor de backoffice worden beschreven in het Nederlands. Voor de selfservice student en docent worden de werkinstructies ook in het Engels geschreven. LET OP: printscreens moeten dus ook in het Engels.

Release afhankelijk

Een werkinstructie is gebaseerd op een release. Bij een nieuwe release/patch moet worden bekeken of en welke werkinstructies moeten worden aangepast. In elke werkinstructies worden tags toegevoegd met de menunummers. Wanneer je in Screensteps zoekt op menunummers, dan zie je alle werkinstructies die screenshots bevatten met die menunummers.

Doel van de werkinstructie

Doel van de werkinstructie

Elke werkinstructie bevat een titel en onder de titel een onderschrift. In het onderschrift wordt vermeld wat het doel van de instructie is, en voor wie de instructie is bedoeld.

Kaders en pijlen

De kaders en pijlen die worden gebruikt zijn standaard donker rood. Dat is ook de preferente kleur die gebruikt wordt. Fel rood is teveel een waarschuwing of fout.

Grootte van de screenshots

Grootte van de screenshots

Niet elk screenshot hoeft een geheel scherm te presenteren. Het eerste screenshot in de stap "Ga naar" moet wel een volledig scherm tonen. Dit geeft een rustig en consistent beeld en het geeft informatie over de versie waarmee de werkinstructie is gemaakt. Het is daarom belangrijk dat in het eerste screenshot het onderste gedeelte van het scherm zichtbaar is met de versie van Osiris.

Opmaak van de werkinstructie

Er is een standaard sjabloon dat gebruikt dient te worden voor de opmaak van je werkinstructie. Hier vindt je het sjabloon.

Lijstfuncties

Lijstfuncties

Bij een opsomming (zeker wanneer deze wordt gedaan in combinatie met een nummering in het screenshot) gelieve gebruik te maken van de lijstfunctie.

Velden en knoppen beschrijven

Wanneer in de werkinstructie een veld of een knop wordt beschreven gebeurt dat als volgt:

  • Een knop wordt beschreven met "brackets". Voorbeeld: [Opslaan]
  • Een veld wordt beschreven met dubbele quotes. Voorbeeld: "Examendoel"

Informatie over velden

Het is wenselijk om bij werkinstructies waarin instructies worden gegeven over de invulling van velden, de werking van de velden ook uit te leggen. In sommige gevallen zal dat ook uit de help tekst in Osiris terug te vinden zijn. In voorkomende gevallen zal dus de informatie over velden (indien deze beschikbaar is in Osiris help), gekopieerd kunnen worden naar de werkinstructie.

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.