Sådan oprettes en brugermanual til din Database (7 trin)
Alrighty! Hvem er glade for at tale brugermanualer?
jeg forstår det. Men hvis du er ligesom mig, så er du enig i at dokumentere processer & systemer er afgørende for enhver nonprofit. Det er bare et spørgsmål om at finde tid til at gøre det.
og hvorfor skulle vi ikke? Dokumentation sparer os tid i det lange løb. Det sparer os fra unødvendige møder & fejlfinding ved at give personalet mulighed for at finde deres egne svar.
for ikke at nævne, det er en darn god færdighed at have. Og det er afgørende at opretholde dit arbejde, hvis du & din org del måder.
prøv at afsætte tid til at gøre dette. Trinene nedenfor skal hjælpe med at gøre dette så smertefrit som muligt…og hvis ikke, er der en “freebie” mod slutningen, du vil have fat i.
Begynd med en oversigt.
før du indtaster procedurer og definitioner, skal du overveje strukturen i dit dokument. Hvad er de emner, der vil være let for personalet at følge? Og hvilken struktur vil være let for dig at opdatere over tid?
Spoiler: dette bliver din indholdsfortegnelse!
til example…my holdets Salesforce manual er brudt fra hinanden hovedsageligt af objekter. Men afhængigt af din opsætning kan opdeling af emner efter afdeling eller funktion give mere mening.
start bredt. Derefter, smal.
din manual er forpligtet til at have specifikke detaljer og trinvise instruktioner. I bund og grund, alle de ting, vores kolleger bliver ved med at glemme.
men god dokumentation vil også give et nyttigt, fugleperspektiv af, hvordan dit system er organiseret & hvorfor. Husk det, når du planlægger din oversigt i Trin 1.
p.S. Jeg kan varmt anbefale diagrammer din datamodel. Du kan bruge et gratis værktøj som Google tegninger eller bygge noget i et ord eller et dokument (ved hjælp af figurer & linjer). Behøver ikke at være fancy!
Definer alle dine data.
hvert teknisk aktiv i din database er en manifestation af nogle virkelige “ting”: om det er en person (donorer, frivillige osv.), transaktion (donation, tilskud osv..) eller partnerskab (programlevering).
god dokumentation vil bygge bro mellem det virkelige og det tekniske ved at definere, hvad dine objekter & felter repræsenterer i den faktiske verden.
Meta, jeg ved det.
Instruer dine brugere.
din brugermanual skal gøre to ting: definere og instruere.
hvis personalet skal udføre opgaver i din database – dataindtastning, dataopdateringer, selv søgning – hjælp dem ved at inkludere trinvise instruktioner til disse ting.
tip: nummererede lister & korte sætninger er din ven her.
skriv alt en gang. Trim derefter gentagne gange.
vi kender alle smerten ved at læse en manual, der er lang, ordrig og kvalt i tekst. Spar dine kolleger. Bang ud det første udkast, og planlægger at bruge masser af tid på at trimme det ned.
hvorfor? Fordi mindre er mere. Og det tager tid at sammensætte dokumentation, der er omfattende og effektiv, mens den stadig er kortfattet.
p.S. Jeg siger ikke at skære ting ud af hensyn til kortfattethed. Jeg siger, at kortfattet dokumentation er en kunst – en, der ikke lander på første forsøg.
Gør brug af hvidt rum.
tænk på dette i form af brugeroplevelse. På samme måde som du holder af, at din database er brugervenlig, vil du også have, at din manual skal være let at gennemse.
jo mere hvidt rum der er – afstanden mellem/omkring din tekst – jo bedre. Overvej også din skriftstørrelse, linjehøjde og kugleafstand.
brug kun skærmbilleder, hvor du skal.
skærmbilleder er fantastiske. Hvorfor forklare noget for nogen, når du også kan vise dem?
men jeg tror personligt, de er lidt af en fælde. I hvert fald når det kommer til dokumentation.
tænk over det. Hvis der ændres noget i dit systems grænseflade, skal du tage fat på og erstatte disse billeder. De kan også distrahere fra dine skriftlige instruktioner, især hvis du bliver båret væk.
derfor bruger jeg dem primært til at fremhæve noget, som mine brugere ellers måske savner.
🌟 en ting mere, der kan hjælpe….
nu hvor vi har vores skridt, er det tid til at begynde at bygge! For at hjælpe har jeg oprettet en brugermanualskabelon, som jeg deler med alle, der ønsker det – til Microsoft-ord eller Google Docs!
alt du behøver er en e-mail-adresse. Følg dette link for at tjekke det ud og få fat i din kopi.
da dette er en database blog, en hurtig note! Ved at tilmelde dig for at modtage skabelonen bliver du også føjet til min blogs e-mail-liste (som jeg aldrig deler med tredjepart). Jeg sender hver anden måned opdateringer og lejlighedsvise meddelelser, som du kan fravælge når som helst.