Het schrijven van een handleiding

Implementatie
,
#1

Hoi hoi!

Ik schrijf regelmatig een handleiding of een Quick Reference Card voor onze klanten toegespitst op hun werkzaamheden en werkafspraken inzake het gebruik van ons CRM. Nu ben ik daar gewoon ooit mee begonnen met als voorbeeld iets wat een collega ooit eerder heeft geschreven. Waar ik al snel achter was is dat ik twee oplevermomenten dien te plannen, een conceptversie waarop geschoten mag worden én een definitieve versie. Zo had ik ooit een handleiding geschreven, toen ik deze opleverde was de lay out toch niet zoals ze graag wilden, kon ik alles omzetten, onder andere daarom nu twee momenten.

Ik ben benieuwd hoe anderen dit aanpakken, heb je een bepaalde werkwijze die je aanhoudt bijvoorbeeld? Andere tips en tricks wellicht?

:sunglasses:

1 like
De beste topics om te lezen
Wat is jouw favoriete topic uit 2018?
#2

Anne , praten we hier over het schrijven van een algemene QRC /handleiding of hebben we het over een maatwerk QRC/handleiding voor een klant? Oftewel maatwerk.

#3

Als ik er een schrijf is het altijd maatwerk in de zin van: toegespitst op de werkwijze van de klant. Die is overal anders uiteraard.
Hoe zou jij het aanpakken?

#4

Anne, ik heb een positieve ervaring door een QRC/handleiding te schrijven met een klant waarbij we dit samen deden , zeg maar als een interorganisatie waarbij je gezamenlijke belangen hebt en ook beiden mandaat hebt om keuzes te maken namens je organisatie. Daarbij kent je partner in business zijn/haar organisatie beter en kan sneller schakelen of bepaalde stukken van de handleiding matchen met de realiteit binnen de de organisatie. Ook is hij/zij een prima ambassadeur om zaken sneller voor elkaar gedaan te krijgen opdat je planning niet uit de hand looopt.

#5

Hoi Daniel, bedankt voor je reactie.

Als ik ga schrijven dan is de inrichting van het systeem bepaald en zijn de werkwijzes bekend, anders blijf je inderdaad aan het aanpassen. Het is wel fijn als je één contactpersoon hebt die zaken kan beantwoorden/navragen binnen de organisatie. Zijn er meer mensen die mogen schieten op de handleiding is dat, naar mijn mening, de verantwoordelijkheid van de contactpersoon om dat te realiseren en mij van (verzamelde) feedback te voorzien.

Ik ben ook op zoek naar tips/tricks over het inrichten van de lay-out/handige dingen die je in word kunt toepassen bijv.

#6

Een verzoek tot maken van een handleiding is natuurlijk makkelijk gedaan en als er iets is daarop schieten nog veel makkelijker.
Zorg dat er verbinding en overeenstemming is met de opdrachtgever. Zet de klokken gelijk.
Mijn gedachte is besteed vooral veel aandacht aan het voortraject. Wat wil de opdrachtgever precies. Leg dat vast zodat je beiden weet wat je afspreekt.

En daarbij nog belangrijker wat wil de opdrachtgever niet. Concreet met welk doel ga jij aan het schrijven. Vraag hier duidelijk in door, een aanname is namelijk zo gedaan.

Misschien is het handig om met een vast sjabloon te gaan werken. Zodat je iets kan laten zien hoe je werkt. En dan hoef je de buitenkant niet elke keer opnieuw uit te vinden.Herkenbaarheid levert het op.

En belangrijk we zijn vaak lui dus neem ook een doel bijvoorbeeld kan ik het op één a4 kwijt.

Om in de juiste flow van schrijven te komen stel ik altijd een timer in. Bijvoorbeeld een inschatting ik ga dit in een half uur schrijven. Dit geeft je de juiste druk en dan is het vaak ook klaar. Wat je zelf al schrijft werken inderdaad met een versie 1 en 2.

3 likes
#7

Hoi Anne,

Ik zorg dat ik de huisstijl van de klant te pakken krijg. Ik zorg dat de kleuren altijd verwerkt zijn in de handleiding.
Verder is, wat hier al is gezegd, afstemming heel belangrijk. Wat willen ze in de handleiding hebben?

Verder lever ik standaard bij een maatwerk handleiding altijd een hoofdstuk of QRC aan met algemene handelingen van het systeem. Ik merkte dat ik heel veel herhaling aan het typen was bij elke processtap en afbeeldingen van de handelingen. Ik vraag me altijd af hoeveel een handleiding gebruikt wordt, maar door het groter te maken dan nodig is, schrikt het al helemaal af. Daarom is mijn tip om repetitieve handelingen te bundelen in één hoofdstuk en daar indien nodig naar te verwijzen. Vaak kennen mensen die basis wel en willen ze juist iets kleins weten.

Ik probeer ook rekening te houden met dat de handleiding als een soort kennisbank kan fungeren. Duidelijke stappen erin, niet teveel wollige tekst, maar hands on en daarbij een goede inhoudsopgave die automatisch is, zodat men er alleen maar op hoeft te klikken en doorgelinkt wordt naar de juiste pagina/hoofdstuk.

Leuk onderwerp trouwens, aangezien het een dagelijkse praktijk voor me is! Ben benieuwd naar nog meer reacties.

#8

@jeroen en @Marloes.van.Dun: dank voor jullie reacties, leuk!

Dit zijn fijne tips waar ik wat mee kan. Ik probeer voor mezelf op een rijtje te krijgen welke acties ik stapsgewijs kan doorlopen samen met de klant:

  • doel handleiding bepalen
  • onderwerpen inventariseren
  • conceptversie schrijven
  • feedback verwerken
  • definitieve versie aanleveren

Naast deze stappen kan ik letten op:

  • lay out - kleuren en logo’s van klant gebruiken
  • goede inhoudsopgave met linkjes naar hoofdstukken
  • basishoofdstuk met repetitieve handelingen
  • op één pagina of volledige handleiding?

Dat van die timer is een goede suggestie! Deze ga ik zeker toepassen, alleen al om beter in te kunnen schatten hoe lang ik ergens mee bezig ben.

Nog aanvullingen?

#9

Ik denk dat je compleet bent. Neem dit mee als handvat en kijk of het werkt. Indien nodig kun je finetunen.

#10

Werken jullie (Jeroen en anderen) ook met een begrippenlijst in een handleiding?

#11

Mijn suggestie is om waar mogelijk de link te maken met kwaliteitsmanagement. Het format van de “QRC’s” zoals ik deze maak zijn in feite ook instrumenten voor het monitoren, coachen en verbeteren van de kwaliteit van de CRM werkwijzen. Naast een overzicht en uitleg van het betreffende klant-/werkproces integreer ik +/- 10 punten waarop medewerkers eigen of elkaars werk kunnen scoren/coachen. Naast het actief verbeteren van de persoonlijke prestaties vormt dit ook een goede basis voor actief betrekken van gebruikers en het samen verbeteren van de standaard werkwijzen.

2 likes
#12

Ik ben bij een opdrachtgever (waar ik toen in huis zat als CRM projectmanager) gewoon begonnen met het verzamelen van printscreens van concrete voorbeelden waar iets fout was gegaan. Of hoe het er uit zou moeten zien.
Resultaat was dan ook dat er van alles en nog wat door elkaar stond, maar wél met alle relevante voorbeelden benoemd.
Ten slotte heeft de CRM-manager aan wie ik het stokje heb overgedragen, er een mooi boekwerk van gemaakt. Echter, dat is wel een ‘groeiend’ document. Want je komt wel vaker voorbeelden tegen - andere afdelingen bijvoorbeeld die aansluiten -waar ook iets mee aan de hand is, en die een verklaring of uitleg verlangen.
Voor een andere opdrachtgever heb ik inderdaad eens een aparte woordenlijst gemaakt, met uitleg van algemene CRM-begrippen en specifieke uitleg horend bij dat bedrijf.
Overigens ben ik ook nog wel eens bij een organisatie vijf jaar na dato mijn eigen handleiding tegen gekomen, waar nooit meer een aanvulling op was gekomen, omdat er op enig moment geen CRM-eindverantwoordelijke meer was … Die zijn intussen weer met een nieuw CRM-traject gestart :sleepy:

Jij nog ervaringen hierover @y.neuschwanger-kars?

1 like
#13

Wat ik ook vaak gebruik bij een handleiding is een opname maken van de handelingen. Vooral de zaken die niet zo vaak gedaan worden.
Blijkt zeer nuttig te zijn in de praktijk.

1 like
#14

Het begrip ‘handleiding’ is soms wat verwarrend merk ik, hier in huis is het geen praktische gebruiksaanwijzing maar een bundeling van gemaakte werkafspraken. Welke kenmerken hebben wij benoemd, hoe gaan we om met bepaalde type contactpersonen, welke verantwoordelijkheden liggen bij welke afdelingen. En dat laatste op zo’n concreet mogelijk niveau, zodat je ook weet wie je kunt aanspreken als er iets niet goed gaat. Wat dat betreft vind ik de eerste bullet uit jouw rijtje @anne.hopman de belangrijkste: wat is het doel van de handleiding. Zorg ook dat je in de inleiding direct aan verwachtingmanagement doet als het gaat om dat doel :grin:

Verder is het aan de ene kant, zoals @katja zegt een groeiend document, maar daarnaast vooral ook een dynamisch document. Want afspraken veranderen, net als inzichten en de CRM-organisatie zelf. Als je daar niet alert op bent devalueert het document als een malle en wordt het niet meer gebruikt. En ben je dus inderdaad terug bij af.

1 like