Close

Categorieën

Sjabloon instructie-artikel

door Atlassian

Leer je team vrijwel alles

Sjabloon gebruiken
Sjabloon instructie-artikel

Er zijn honderden kleine (en grote) dingen die we iedere dag doen om ons werk te doen, en zo veel daarvan gaat op de automatische piloot. Wat voor jou routine is, is een hindernis voor een ander. Dat is waar het sjabloon Instructie-artikel voor gemaakt is: het beschrijven van de stappen die nodig zijn om een blog op te zetten, je wachtwoord te wijzigen, je voordelentoewijzing bij te werken en voor al het andere dat in je bedrijf gebeurt. Dit sjabloon bespaart tijd en leert iedereen alles.

Deze sjabloon gebruiken

Stap 1. Weet wat je doet

Het Instructie-artikel dat je gaat maken zal hopelijk een basis zijn voor iedereen in je team (en je bedrijf) om taken uit te voeren, hindernissen te nemen en projecten sneller te verzenden. Jij bent misschien al een expert in het doen van je werk, maar het is waardevol om even de tijd te nemen om te kijken hoe het je collega's vergaat. Vergelijk je ervaringen en neem wat van hun aanbevolen werkwijzen mee in het document dat je gaat maken. 

Denk ook aan de vragen die je vaak krijgt over deze taak en welke vragen je alvast kan beantwoorden om verwarring voor de lezer te voorkomen (en om jezelf tijd te besparen omdat je wijzigingen en gesprekken voorkomt). Denk bijvoorbeeld aan een instructie-artikel over het bijwerken van je betaalgegevens in het payroll-portaal. Welke vragen hebben ze voor ze beginnen? ('Hoe lang duurt het om te verwerken?') Wat is de eerste stap die ze ondernemen? (Inschrijven bij het portaal en aanmelden.) Hoe kunnen ze tijd besparen? (Houd je rekeningnummer en andere gegevens bij de hand als je begint, aangezien het portaal na 10 minuten zonder activiteit een time-out geeft.)

Stap 2. Maak een overzicht

Heb je alle feiten en de beste tactieken opgeschreven? Dan is het tijd om een overzicht te maken van alle stappen die iemand moet doorlopen om deze taak uit te voeren. Probeer je overzicht zo gedetailleerd mogelijk te maken; een instructie-artikel is een stuk makkelijker te maken met een duidelijk overzicht. Probeer het wel te beperken tot 3 tot 5 stappen, zodat je lezer niet het gevoel krijgt dat het proces heel veel tijd kost.

Vergeet niet dat sommige mensen informatie opnemen door te lezen, anderen door visuele informatie, weer anderen via audio en nog weer anderen door een combinatie van deze vormen. Vergeet in je overzicht dus niet te noteren welke plaatjes, filmpjes of screenshots je nodig hebt om je instructies echt vorm te geven. 

Stap 3. Verzamel illustraties, afbeeldingen en screenshots

Plaatjes geven meer structuur en maken de instructies gemakkelijker te volgen. Deze stap is erg makkelijk als je al een bibliotheek van beeldmateriaal hebt om uit te putten. Als je dit nog niet hebt, neem dan even de tijd om te spreken met je creatieve team, externe leveranciers of anderen die hierbij kunnen helpen en verzamel materialen. Tip: je kunt het materiaal ook zelf maken met gratis screenshotprogramma's of online designprogramma's. 

Verzamel ook links naar content die belangrijk is voor dit proces die niet direct onderdeel uitmaakt van de procesflow, maar wel nuttig kan zijn (zoals betaalschema's).

Stap 3. Verzamel illustraties, afbeeldingen en screenshots

Stap 4. Vraag een externe mening, of meerdere

Your outline is robust and includes all the steps you think make sense. Now’s the time to see if you missed anything or if any step needs more clarification. Run your outline by someone who is familiar with the process to see if they can add anything.

Flesh out your outline into a legit how-to piece using the Confluence template. Once you feel good about the draft, run it by someone who has no clue how this process works and ask them to go through it. Was it smooth sailing or did they hit a snag? And where? Clean up the instructions where your reviewer got stuck. 

Stap 5. Publiceer en wacht feedback af

Klaar voor de start, publiceren! Je instructie-artikel is nu online om iedereen die dat nodig heeft te helpen en jou tijd te besparen nu je niet meer steeds dezelfde vragen hoeft te beantwoorden. Hoewel je grondig bent geweest met het verzamelen van feiten en het testen van je artikel, kan het zijn dat er toch nog collega's met vragen zijn.

Het prettige van werken met Confluence is dat de content voor iedereen beschikbaar is; iedereen kan reageren met vragen en opmerkingen. Bovendien kun je in Confluence zo veel aanpassingen maken als nodig is, dus ieder document leeft. Je kunt je document wijzigen en mee-ontwikkelen met de behoeftes en werkwijzen van je team.


Atlassian is een softwarebedrijf dat producten voor softwareontwikkelaars, projectmanagers en contentbeheer ontwikkelt.

  • AWS architecture diagram template

    Lucidchart

    Diagram van AWS-architectuur

    Visualiseer je infrastructuur om zwakke punten en verbeterpunten beter in kaart te brengen.

  • DevOps runbook template

    Atlassian

    DevOps-runbook

    Bereid je operationsteam voor om snel te reageren op systeemmeldingen en onderbrekingen.

  • DevOps change management template

    Atlassian

    DevOps-wijzigingsbeheer

    Gebruik deze sjabloon om de prestaties van je wijzigingsbeheer te beoordelen en risico's te beperken.