Binnen de software van Beonder maken mensen gebruik van verschillende functies en toepassingen. Om alle stappen binnen ons systeem toe te lichten hebben we een helpcentrum ingericht. In dit onderdeel leggen we de workflow en de basisprincipes uit van het systeem.
Iemand die een artikel leest binnen het helpcentrum zoekt meestal naar een antwoord op een specifieke vraag. Het is onze bedoeling om gebruikers zo snel mogelijk te voorzien van het juiste antwoord. Dat doen we door een logische navigatiestructuur aan te brengen en heldere teksten te schrijven.
In het helpcentrum houden we rekening met de volgende factoren:
- Zit de lezer midden in een taak? Hebben ze haast? Zouden ze gefrustreerd zijn?
- Wat is het doel van de lezer? Om een opdracht af te ronden of een onderwerp te onderzoeken?
We willen een lezer niet verzadigen met onnodig veel tekst, we presenteren alleen de nodige informatie. Dit is cruciaal wanneer een gebruiker nieuw en / of gefrustreerd is. Indien nodig kunnen we per onderdeel een korte introductie schrijven. Tijdens het schrijven van technische content houden we zinnen, paragrafen en stappen gefocust en beknopt.
Indeling
Het helpcentrum van Beonder is opgedeeld in drie categorieën, namelijk: opdrachten, vragenlijst beheren en instellingen voor beheerders. Binnen ons systeem werken meerdere gebruikers aan wie verschillende rollen en rechten zijn toegewezen. Op basis van deze rollen en rechten is een logische indeling gemaakt, zodat iedere gebruiker snel de juiste informatie kan vinden.
Richtlijnen
Voordat we beginnen met het schrijven van technische content overleggen we met verschillende collega’s hoe de functies werken en hoe we dit kunnen vertalen in een stappenplan. Belangrijk is om vast te houden aan de basisprincipes van de functies binnen onze software. Hierdoor blijven de teksten helder en begrijpbaar.
Controle
Na het schrijven van technische content wordt een controle uitgevoerd door een collega en iemand die geen of weinig kennis heeft van ons systeem. Een collega controleert of alle onderdelen correct zijn beschreven. Daarnaast kan een lezer die nog niet vaardig is met de software beoordelen of alle stappen op een begrijpelijke manier zijn beschreven.
Technische inhoud schrijven
Tijdens het schrijven van technische content volgen we de stijlpunten die worden beschreven in de Regels voor een consistente schrijfstijl. Hieronder staan nog een aantal regels en richtlijnen:
Maak gebruik van logische titels
Gebruikers klikken op titels en worden vervolgens doorverwezen naar het artikel. Door gebruik te maken van logische titels kunnen lezers het gewenste antwoord snel vinden. Daarnaast wijken we in het artikel niet af van het onderwerp. We gebruiken links om gerelateerde inhoud beschikbaar te maken.
Houd koppen en alinea’s kort en scanbaar
In het helpcentrum scannen gebruikers de teksten op onderwerp. Daarom maken we gebruik van korte, beschrijvende en logische koppen. Ook de alinea’s zijn zo kort mogelijk geschreven.
Gebruik de tweede persoon
In het helpcentrum maken we gebruik van de je-vorm, zodat we gebruikers op een persoonlijke manier aanspreken.
Eenvoud en duidelijkheid
In het helpcentrum schrijven we zo duidelijk mogelijk door eenvoudige woorden en zinnen te gebruiken. We focussen ons op de specifieke taak en beperken zoveel mogelijk het aantal zinnen per alinea. We beschrijven kort alle acties die gebruikers uitvoeren binnen het systeem.
Screenshots en video’s
Schermafbeeldingen en video’s kunnen nuttig zijn voor nieuwe gebruikers. Zij kunnen zich op deze manier beter oriënteren op alle functies binnen het systeem.
Technische inhoud bewerken
We bewerken technische inhoud op basis van drie doelen:
Snel verwerken
- Schrijf korte zinnen, vermijd passieve constructies.
- Gebruik simpele woorden.
- Houd alinea’s zo kort mogelijk (Het liefst niet meer dan 3 tot 4 zinnen).
- Maak gebruik van lijsten en opsommingen om snel inzicht te geven in verschillende taken.
Consistentie
- Maak gebruik van dezelfde terminologie die in de software wordt gebruikt.
- Gebruik specifieke en actieve werkwoorden voor verschillende taken.
- Kies zo veel mogelijk voor dezelfde basiswoorden en -zinnen zodat er een consistente opbouw ontstaat in verschillende artikelen binnen het helpcentrum.
Behulpzaamheid
- Geef lezers de mogelijkheid om te reageren op technische content.
- Wijs door naar andere mogelijkheden om vragen te beantwoorden.
Video’s opnemen en monteren
Screenvideo’s
Om nieuwe gebruikers van ons systeem nog beter op weg te helpen voegen we video’s toe aan het helpcentrum. Hiervoor is een Beonder Tutorial licentie ingericht, waarin fictieve gegevens zijn opgenomen. Deze licentie gebruiken we om screenvideo’s te maken.
Video’s bewerken
Nadat alle stappen zijn opgenomen beweren we de video. We knippen overbodige muisklikken uit de video en voegen vloeiende overgangen toe.
Inzoomen
Tijdens het monteren van instructievideo’s zoomen we in op bepaalde onderdelen, zodat alle stappen nog duidelijker zijn voor de gebruiker (bijvoorbeeld een klik op de oranje plusknop).
Kader
Voor screenvideo’s nemen we altijd het volledige scherm op. Tijdens het editen van de video knippen we de balk met tabladen uit de video, waardoor alleen de licentie Beonder Tutorial zichtbaar is in de browser.
Duur video
We proberen de video’s binnen 30 seconden op te nemen. Voor sommige onderdelen moeten we echter meer stappen laten zien, waardoor de duur van video langer kan zijn. De regel luidt dat de maximale duur nooit langer dan een minuut mag zijn.