In dit artikel worden de belangrijkste afspraken beschreven die we hebben gemaakt om eenduidige handleidingen te krijgen binnen Saxion. In eerste instantie zijn deze afspraken gemaakt voor de handleidingen voor Brightspace maar deze zijn natuurlijk ook voor andere applicaties toepasbaar.
Inhoudsopgave
- Inleiding
- Algemene afspraken
-
Afspraken om de vindbaarheid en het gebruiksgemak te vergroten
- 1. Gebruik kopjes en subkopjes om hoofdtaken te groeperen
- 2. Maak onderscheid tussen achtergrondinformatie en instructies
- 3. Maak slim gebruik van vette tekst
- 4. Maak spaarzaam gebruik van opgemaakte alinea's
- 5. Gebruik actiegerichte tekst
- 6. Gebruik lijsten met opsommingstekens om tekst op te delen
- 7. Gebruik genummerde lijsten om een opeenvolgende volgorde aan te geven
- 8. Zoek een goede balans voor screenshots
- 9. Gebruik een combinatie van tekstformaten bij het opnemen van tekst en schermafbeeldingen
- 10. Gebruik screenshot-annotaties om acties op het scherm heel duidelijk te maken
- 11. Schrijf GEEN alinea's in de headings (koppen)
- 12. Blur in screenshots alle persoonsgegevens en cursusnamen
- 13. Bij langere artikelen maak je gebruik van een inhoudsopgave
- 14. Gebruik de Saxionkleuren voor de kaders en pijlen
Inleiding
Bij Saxion maken we gebruik van Screensteps voor het maken van duidelijke handleidingen voor het gebruik van applicaties voor het onderwijs. Het grote voordeel van Screensteps is dat Saxion hiermee de beschikking heeft over een openbaar beschikbare website waarbij gebruikers niet hoeven in te loggen om de documentatie te bekijken.
Screensteps bevat een desktop-authoringtool die speciaal is ontworpen voor het maken van handleidingen. Tot de vele ingebouwde functies van de desktopeditor behoren onder meer:
- Zeer eenvoudig schermopnames maken
- Annotaties (bijvoorbeeld cirkels, highlights, vervaging, reeks)
- Opvouwbare secties
- Inline-links naar andere handleidingen, websites of paragrafen binnen de handleiding
- Automatische nummering
- Checklists en beslisbomen
Screensteps werkt intuïtief en is na een instructie van een uur door iedereen met een auteursrol te gebruiken.
Een voorbeeld van een artikel waarin veel van onderstaande afspraken terugkomen vind je hier
Algemene afspraken
1. Formuleer de titel van een artikel zoals de docent of student de vraag zou stellen
Gebruik geen Saxionjargon. Gebruik titels zoals docenten of studenten over het onderwerp zouden praten.
- Welke woorden zouden ze gebruiken?
- Hoe zouden ze de vraag stellen?
2. Let op dat de scope van het artikel niet te breed is
Als de handleiding procedures voor meerdere taken bevat, kan het moeilijk zijn om de juiste te vinden als deze midden in het artikel verborgen is. Elke artikel/handleiding mag slechts één procedure behandelen.
3. Gebruik Additional Search Terms
Je kunt extra zoektermen toevoegen om het artikel gemakkelijker vindbaar te maken als gebruikers andere zoektermen gebruiken om naar het artikel te zoeken.

Afspraken om de vindbaarheid en het gebruiksgemak te vergroten
1. Gebruik kopjes en subkopjes om hoofdtaken te groeperen
Vermijd lange stap-voor-staplijsten. Groepeer in plaats daarvan de stappen in subtaken.
Bijvoorbeeld IN PLAATS VAN:
- Klik op dit ding
- Doe dat ding
- Doe iets anders
- En nog een ding
- En vergeet dit niet
- En nog meer spullen
- En nog iets
DOE DIT:
-
Account aanmaken
- Klik op dit ding
- Doe dat ding
-
Profiel bijwerken
- Doe iets anders
- En nog een ding
- En vergeet dit niet
-
Machtigingen toevoegen
- En nog meer spullen
- En nog iets
2. Maak onderscheid tussen achtergrondinformatie en instructies
Begin je artikel met achtergrondinformatie: Contextuele of achtergrondkennis die gebruikers helpt basisconcepten te begrijpen.
Vervolgens voeg je instructies toe: de op actie gebaseerde kennis, zoals hoe je een stappenplan volgt. Je hebt achtergrondinformatie nodig om de instructies uit te kunnen voeren.
3. Maak slim gebruik van vette tekst
Maak niet alles vet!
- Bepaal wat je vetgedrukt wilt maken
- Dit kunnen acties zijn die je wil dat gebruikers uitvoeren (zoals klikken op Start)
- Het kan ook een belangrijke tekst zijn die je wil benadrukken
4. Maak spaarzaam gebruik van opgemaakte alinea's
Wees voorzichtig met het gebruik van te veel gekleurde kaders (een optie in Screensteps), zelfs als ze verschillende kleuren hebben.
- Als het hele artikel uit gele kaders bestaat, verliest het zijn doel.
- Als je afwisselt tussen gele, groene, rode en blauwe kaders ziet het eruit als een regenboog en is het moeilijk te lezen.
- Als je iets (redelijk) dwingend wil voorschrijven kies je voor een rood kader - Style: Alert.

- Gekleurde kaders worden Text styles genoemd in Screensteps. Je kunt kiezen uit de volgende stijlen:

5. Gebruik actiegerichte tekst
Schrijf geen alinea waarin je uitlegt hoe je een taak moet aanpakken. Gebruik in plaats daarvan een genummerde lijst met instructies met opsommingstekens.
IN PLAATS VAN: Eerst wil je het stuk uit het onderdeel halen. Zodra het onderdeel uit het stuk is, zul je zien dat er een spoel zit. Deze spoel moet rond zijn en zal waarschijnlijk in de opening worden gestoken. Zodra je ziet dat de spoel in de opening zit, wil je het stuk pakken en over de spoel plaatsen.
DOE DIT:
- Haal een stuk uit een onderdeel
- Controleer of de cirkelvormige spoel zich in de opening bevindt
- Plaats het stuk over de spoel
6. Gebruik lijsten met opsommingstekens om tekst op te delen
Gebruik opsommingstekens in plaats van lijsten te scheiden met komma's. Bijvoorbeeld:
IN PLAATS VAN: U moet bevestigen dat u de volgende items heeft: aluminiumfolie, kip, saus, oregano en peterselie.
DOE DIT:
Bevestig dat je over het volgende beschikt:
- aluminiumfolie
- kip
- saus
- oregano
- peterselie
7. Gebruik genummerde lijsten om een opeenvolgende volgorde aan te geven
Als acties in een specifieke volgorde moeten worden ondernomen, gebruik dan geen lijst met opsommingen, maar een genummerde lijst. Bijvoorbeeld:
IN PLAATS VAN:
- Haal een stuk uit een onderdeel
- Controleer of de cirkelvormige spoel zich in de opening bevindt
- Plaats het stuk over de spoel
DOE DIT:
- Haal een stuk uit een onderdeel
- Controleer of de cirkelvormige spoel zich in de opening bevindt
- Plaats het stuk over de spoel
Voeg voor de duidelijkheid screenshots toe en plaats genummerde icoontjes in de afbeelding die overeenkomen met bovengenoemde nummering. Plaats de actielijst boven de afbeelding. Zie het onderstaande voorbeeld.

8. Zoek een goede balans voor screenshots
- Te weinig screenshots en de gebruiker kan verdwalen
- Te veel en het wordt overdreven
- Voeg schermafbeeldingen toe wanneer deze nodig zijn
9. Gebruik een combinatie van tekstformaten bij het opnemen van tekst en schermafbeeldingen
Als je screenshot-instructies toevoegt, combineer dan koppen met gewone tekst en afbeeldingen. Bijvoorbeeld:

10. Gebruik screenshot-annotaties om acties op het scherm heel duidelijk te maken
Gebruik duidelijk pijlen, vakjes en cijfers om de klikken en stappen aan te wijzen die de lezer moet nemen.

11. Schrijf GEEN alinea's in de headings (koppen)
Het doel van de koptekst is om het document op te splitsen. Koppen moeten korte zinnen zijn. Als u meer uitleg nodig heeft, kunt u hieronder een stukje tekst toevoegen. Bijvoorbeeld:
IN PLAATS VAN: Navigeer naar Account en klik op Gebruikers, wat de eerste optie is onder Accountinstellingen
DOE DIT:
Navigeer naar Gebruikers
- Klik op Account
- Klik op Gebruikers (eerste optie onder Accountinstellingen)
12. Blur in screenshots alle persoonsgegevens en cursusnamen
Zorg ervoor dat er geen persoonsgegevens van studenten of docenten zichtbaar zijn in de screenshots. Ook de naam van de cursus wordt geblurd tenzij deze zichtbaar moet zijn voor de toelichting in de handleiding.
- Klik op de afbeelding van een screenshot en klik in de tools op de B.
- Kies de gebieden die je wil blurren:
- Je eigen naam en evt. afbeelding rechtsboven
- De naam van de cursus
- Alle persoonsgegevens van docenten en studenten

13. Bij langere artikelen maak je gebruik van een inhoudsopgave
Als een artikel langer is dan 1 a 2 x scrollen maak dan een inhoudsopgave van de paragrafen. Zie ook het voorbeeld boven aan dit artikel.

- Maak na de (korte) inleiding
- Een heading aan
- Noem deze: Inhoudsopgave
- Maak een extra paragraaf aan
- Start met een opsommingsteken
- Klik op Insert Link
- Kies bij Heading Link achtereenvolgens de verschillende paragrafen.
14. Gebruik de Saxionkleuren voor de kaders en pijlen
Het is het mooist als je voor de kaders en pijlen die je toevoegt aan de screenshots de Saxionkleuren gebruikt. Je kunt dit eenmalig doen, daarna onthoudt Screensteps deze instelling.
Kleur Image border aanpassen:
- Klik op een screenshot waar je een kader of pijl wil toevoegen
- Klik op het icoontje voor een kader of op de pijl
- Klik rechts op Border color en kies links voor Aangepaste kleur definiëren
- Vul de volgende waarden in.
