Hoe maak je een Gebruikershandleiding voor je Database (7 stappen)
Okidoki! Wie heeft er zin in gebruikershandleidingen?
kijk, ik snap het. Maar als je net als ik bent, Dan ben je het ermee eens dat het documenteren van processen & systemen essentieel is voor elke non-profit. Het is gewoon een kwestie van de tijd vinden om het te doen.
en waarom zouden we niet? Documentatie bespaart ons tijd op de lange termijn. Het voorkomt onnodige problemen bij vergaderingen & door medewerkers in staat te stellen hun eigen antwoorden te vinden.
niet te vergeten, het is een verdomd goede vaardigheid om te hebben. En het is cruciaal om je werk te ondersteunen, mocht je & je organisatie uit elkaar gaan.
probeer tijd vrij te maken om dit te doen. De onderstaande stappen moeten helpen om dit zo pijnloos mogelijk te maken … en zo niet, er is een “freebie” tegen het einde zul je willen grijpen.
Begin met een overzicht.
voordat u procedures en definities typt, moet u rekening houden met de structuur van uw document. Wat zijn de onderwerpen die gemakkelijk zullen zijn voor het personeel om te volgen? En welke structuur zal gemakkelijk voor u zijn om na verloop van tijd bij te werken?
Spoiler: dit wordt uw inhoudsopgave!
voor example…my team ‘ s Salesforce handleiding wordt uit elkaar gebroken voornamelijk door objecten. Maar afhankelijk van je setup, kan het splitsen van onderwerpen per afdeling of functie zinvoller zijn.
begin breed. Dan, smal.
uw handleiding moet specifieke details en stapsgewijze instructies bevatten. Kortom, alle dingen die onze collega ‘ s steeds vergeten.
maar goede documentatie geeft ook een handig overzicht van hoe uw systeem is georganiseerd & waarom. Houd dat in gedachten als u van plan uw overzicht in Stap 1.
P. s. Ik beveel het diagrammen van uw datamodel aan. U kunt een gratis tool gebruiken zoals Google Drawings, of iets in een Word of Powerpoint doc bouwen (met behulp van vormen & lijnen). Het hoeft niet chique te zijn!
definieer al uw gegevens.
elke tech asset in uw database is een manifestatie van een real-life “ding”: of het nu een persoon (donoren, vrijwilligers, enz…), transactie (donatie, subsidie, enz..), of partnerschap (programma levering).
goede documentatie overbrugt de kloof tussen de echte en de technische, door te definiëren wat uw objecten & velden vertegenwoordigen in de werkelijke wereld.
Meta, dat Weet ik.
Instrueer uw gebruikers.
uw gebruikershandleiding moet twee dingen doen: definiëren en instrueren.
als personeel taken in uw database moet uitvoeren – gegevensinvoer, gegevensupdates, zelfs zoeken – help hen door stap-voor-stap instructies voor die dingen op te nemen.
Hint: genummerde lijsten & korte zinnen zijn uw vriend hier.
schrijf alles één keer. Dan trimmen, herhaaldelijk.
We kennen allemaal de pijn van het lezen van een handleiding die lang, lang en verstikt is in de tekst. Spaar je collega ‘ s. Pak die eerste versie en ga veel tijd besteden aan het afknippen.
waarom? Want minder is meer. En het kost tijd om documentatie samen te stellen die uitgebreid en effectief is, terwijl het nog steeds beknopt is.
p. s.Ik zeg niet om dingen uit te sluiten omwille van de beknoptheid. Ik zeg dat beknopte documentatie een kunst is – een die niet bij de eerste poging landt.
maak gebruik van witte ruimte.
denk aan dit in termen van UX (user experience). Net zoals u wilt dat uw database gebruiksvriendelijk is, Wilt u ook dat uw handleiding gemakkelijk te bladeren is.
hoe meer witruimte er is – de ruimte tussen / rond uw tekst – hoe beter. Overweeg ook uw lettergrootte, lijnhoogte en opsommingsteken.
gebruik alleen screenshots waar je moet.
schermafbeeldingen zijn fantastisch. Waarom leg je iemand iets uit als je het ook kunt laten zien?
maar persoonlijk geloof ik dat ze een beetje een val zijn. Tenminste als het om documentatie gaat.
denk er eens over na. Als er iets verandert in de interface van je systeem, moet je die afbeeldingen opnieuw pakken en vervangen. Ze kunnen ook afleiden van uw schriftelijke instructies, vooral als u zich laat meeslepen.
daarom gebruik ik ze vooral om iets te markeren wat mijn gebruikers anders zouden missen.
🌟 nog een ding dat zou kunnen helpen….
nu we onze stappen hebben, is het tijd om te beginnen met bouwen! Om te helpen heb ik een sjabloon voor gebruikershandleidingen gemaakt die ik deel met iedereen die het wil – voor Microsoft Word of Google Docs!
alles wat u nodig hebt is een e-mailadres. Om het te controleren en pak uw exemplaar, volg deze link.
aangezien dit een database blog, een snelle opmerking! Door je aan te melden om de sjabloon te ontvangen, word je ook toegevoegd aan de e-maillijst van mijn blog (die ik nooit met derden deel). Ik stuur tweemaandelijkse updates en af en toe aankondigingen, die u kunt afmelden op elk gewenst moment.