Cum de a crea un Manual de utilizare pentru baza de date (7 pași)
Alrighty! Cine este încântat să vorbească manuale de utilizare?
Uite, am înțeles. Dar dacă sunteți ca mine, atunci sunteți de acord că documentarea proceselor & sisteme este esențială pentru orice non-profit. Este doar o chestiune de a găsi timp pentru a face acest lucru.
și de ce nu am face-o? Documentația ne economisește timp pe termen lung. Ne scutește de întâlniri inutile & depanare ,prin împuternicirea personalului pentru a găsi propriile răspunsuri.
să nu mai vorbim, este o abilitate darn bun pentru a avea. Și este crucial pentru susținerea munca ta, ar trebui să vă & căile tale parte org.
încercați să alocați timp pentru a face acest lucru. Pașii de mai jos ar trebui să vă ajute să faceți acest lucru cât mai nedureros posibil…și dacă nu, există un „freebie” spre final pe care veți dori să îl apucați.
începeți cu o schiță.
înainte de a introduce proceduri și definiții, luați în considerare structura documentului. Care sunt subiectele care vor fi ușor de urmărit de personal? Și ce structură vă va fi ușor de actualizat în timp?
Spoiler: acesta devine cuprinsul tău!
pentru example…my manualul Salesforce al echipei este rupt în principal de obiecte. Dar, în funcție de configurația dvs., împărțirea subiectelor în funcție de departament sau funcție poate avea mai mult sens.
începe larg. Apoi, îngust.
manualul dvs. este obligat să conțină detalii specifice și instrucțiuni pas cu pas. Practic, toate lucrurile pe care colegii noștri le uită.
dar documentație bună va oferi, de asemenea, o vedere utilă, păsări ochi de modul în care sistemul este organizat & de ce. Rețineți acest lucru pe măsură ce vă planificați conturul în pasul 1.
p.S. Am foarte recomanda diagrame modelul de date. Puteți utiliza un instrument gratuit, cum ar fi desene Google, sau de a construi ceva într-un Word sau Powerpoint doc (folosind forme & linii). Nu trebuie să fie fantezie!
definiți toate datele.
fiecare activ tehnic din Baza de date este o manifestare a unui „lucru” din viața reală: fie că este vorba de o persoană (donatori, voluntari etc.), tranzacție (donație, subvenție etc..) sau parteneriat (livrarea programului).
o documentație bună va reduce decalajul dintre real și tehnic, definind ceea ce obiectele dvs. & câmpuri reprezintă în lumea reală.
Meta, știu.
instruiți-vă utilizatorii.
manualul dvs. de utilizare ar trebui să facă două lucruri: să definească și să instruiască.
dacă personalul trebuie să îndeplinească sarcini în baza dvs. de date – introducerea datelor, actualizările datelor, chiar căutarea – ajutați-i să includă instrucțiuni pas cu pas pentru aceste lucruri.
sugestie: liste numerotate & propoziții scurte sunt prietenul tău aici.
scrie totul o dată. Apoi tăiați, în mod repetat.
știm cu toții durerea citirii unui manual care este lung, prolix și sufocat în text. Cruță-ți colegii. Bang out că primul proiect, și planul de a petrece o mulțime de timp tunderea-l jos.
de ce? Pentru că mai puțin este mai mult. Și este nevoie de timp pentru a pune împreună documentația care este cuprinzătoare și eficientă, în timp ce încă fiind concis.
p.S. nu spun să tăiem lucrurile de dragul conciziei. Spun că documentația concisă este o artă-una care nu aterizează la prima încercare.
folosiți spațiul alb.
gândiți-vă la acest lucru în termeni de UX (experiența utilizatorului). În același mod în care vă pasă de faptul că baza dvs. de date este ușor de utilizat, doriți, de asemenea, ca manualul dvs. să fie ușor de navigat.
cu cât există mai mult spațiu alb – distanța dintre/în jurul textului dvs. – cu atât mai bine. De asemenea, luați în considerare dimensiunea fontului, înălțimea liniei și spațierea glonțului.
utilizați capturi de ecran numai acolo unde trebuie.
capturile de ecran sunt fantastice. De ce să explici ceva cuiva când îi poți arăta și tu?
dar eu personal cred că sunt un pic de o capcană. Cel puțin atunci când vine vorba de documentare.
gândește-te. Dacă se schimbă ceva în interfața sistemului dvs., va trebui să re-apucați și să înlocuiți acele imagini. De asemenea, pot distrage atenția de la instrucțiunile dvs. scrise, mai ales dacă vă lăsați purtați.
de aceea le folosesc în principal pentru a evidenția ceva ce utilizatorii mei ar putea lipsi altfel.
🌟 încă un lucru care ar putea ajuta….
acum că avem pașii noștri, este timpul să începem să construim! Pentru a vă ajuta, am creat un șablon manual de utilizare pe care îl împărtășesc cu oricine dorește – pentru Microsoft Word sau Google Docs!
tot ce ai nevoie este o adresă de e-mail. Pentru a verifica și apuca copia dvs., urmați acest link.
deoarece acesta este un blog de baze de date, o notă rapidă! Prin înscrierea pentru a primi șablonul, veți fi adăugat și la lista de e-mailuri a blogului meu (pe care nu o împărtășesc niciodată cu terți). Trimit actualizări bilunare și anunțuri ocazionale, din care puteți renunța în orice moment.