Hvordan Lage En Brukerhåndbok for Databasen Din (7 Trinn)
Alrighty! Hvem er glade for å snakke brukerhåndbøker?
Jeg skjønner. Men hvis du er som meg, så er du enig i at dokumentere prosesser & systemer er viktig for enhver ideell. Det er bare et spørsmål om å finne tid til å gjøre det.
Og hvorfor skulle vi ikke? Dokumentasjon sparer oss tid på lang sikt. Det sparer oss fra unødvendige møter & feilsøking, ved å gi personalet mulighet til å finne sine egne svar.
For Ikke å nevne, det er en darn god ferdighet å ha. Og det er avgjørende å opprettholde arbeidet ditt, hvis du & din org deler måter.
Prøv å sette av tid til å gjøre dette. Trinnene nedenfor skal bidra til å gjøre dette så smertefritt som mulig…og hvis ikke, er det en «freebie» mot slutten du vil ta tak i.
Begynn med en oversikt.
før du skriver ut prosedyrer Og definisjoner, bør du vurdere strukturen i dokumentet. Hva er temaene som vil være lett for ansatte å følge? Og hvilken struktur vil være lett for deg å oppdatere over tid?
Spoiler: Dette blir Din Innholdsfortegnelse!
For example…my lagets salesforce-håndbok er brutt fra hverandre hovedsakelig av objekter. Men avhengig av oppsettet ditt, kan deling av emner etter avdeling eller funksjon være mer fornuftig.
start bredt. Deretter smal.
håndboken er bundet til å ha spesifikke detaljer og trinnvise instruksjoner. I utgangspunktet, alle ting våre kolleger holde glemme.
men god dokumentasjon vil også gi et nyttig, fugleperspektiv av hvordan systemet er organisert & hvorfor. Ha det i bakhodet når du planlegger din disposisjon I Trinn 1.
ps jeg anbefaler å diagrammer datamodellen din. Du kan bruke Et gratis verktøy Som Google Tegninger, eller bygge noe i Et Word-eller Powerpoint-dokument (ved hjelp av figurer & linjer). Det trenger ikke være fancy!
Definer alle dataene dine.
Hver tech ressurs i databasen er en manifestasjon av noen virkelige «ting»: om det er en person (givere, frivillige, etc…), transaksjon (donasjon, stipend, etc..), eller partnerskap(programlevering).
God dokumentasjon vil bygge bro over gapet mellom det virkelige og det tekniske, ved å definere hva objektene dine & felt representerer i den virkelige verden.
Meta, jeg vet det.
Instruere brukerne.
brukerhåndboken din bør gjøre to ting: definere og instruere.
hvis ansatte trenger å utføre oppgaver i databasen – dataregistrering, dataoppdateringer, selv søker – hjelpe dem ut ved å inkludere trinnvise instruksjoner for disse tingene.
Hint: Nummererte lister & korte setninger er din venn her.
Skriv alt en gang. Deretter trim, gjentatte ganger.
vi kjenner alle smerten ved å lese en håndbok som er lang, ordaktig og kvalt i tekst. Spar dine kolleger. Bang ut det første utkastet, og planlegger å bruke mye tid på å trimme den ned.
Hvorfor? Fordi mindre er mer. Og det tar tid å sette sammen dokumentasjon som er omfattende og effektiv, samtidig som den er konsis.
ps jeg sier ikke å kutte ting ut for korthetens skyld. Jeg sier at kortfattet dokumentasjon er en kunst – en som ikke lander på første forsøk.
Bruk av hvit plass.
Tenk på dette når det GJELDER UX (user experience). På samme måte som du bryr deg om at databasen din er brukervennlig, vil du også at håndboken skal være enkel å bla gjennom.
jo mer hvitt mellomrom det er-avstanden mellom / rundt teksten din-jo bedre. Vurder også skriftstørrelse, linjehøyde og kuleavstand.
bruk bare skjermbilder der du må.
Skjermbilder er fantastiske. Hvorfor forklare noe til noen når du kan vise dem også?
men jeg tror personlig at de er litt av en felle. I hvert fall når det gjelder dokumentasjon.
Tenk på det. Hvis noe endres i systemets grensesnitt, må du ta tak i og erstatte disse bildene. De kan også distrahere fra dine skriftlige instruksjoner, spesielt hvis du blir båret bort.
derfor bruker jeg hovedsakelig dem til å markere noe brukerne mine ellers ville savne.
🌟 En ting til som kan hjelpe …
nå som vi har våre skritt, er det på tide å begynne å bygge! For å hjelpe, har jeg opprettet en brukerhåndbok mal som jeg deler med alle som ønsker Det-For Microsoft Word eller Google Docs!
Alt du trenger er en e-postadresse. For å sjekke det ut og ta tak i kopien din, følg denne linken.
Siden dette er en database blogg, en rask notat! Ved å registrere deg for å motta malen, blir du også lagt til i bloggens e-postliste (som jeg aldri deler med tredjeparter). Jeg sender bi-månedlige oppdateringer og sporadiske kunngjøringer, som du kan velge bort når som helst.