Come creare un manuale utente per il database (7 passaggi)
Alrighty! Chi è entusiasta di parlare manuali utente?
Senti, ho capito. Ma se siete come me, allora siete d’accordo che documentare i processi & sistemi è essenziale per qualsiasi senza scopo di lucro. E ‘ solo una questione di trovare il tempo per farlo.
E perché non dovremmo? La documentazione ci fa risparmiare tempo nel lungo periodo. Ci risparmia da riunioni inutili & risoluzione dei problemi, consentendo al personale di trovare le proprie risposte.
Per non parlare, è una maledettamente buona abilità da avere. Ed è fondamentale per sostenere il tuo lavoro, se & la tua organizzazione si separa.
Prova a mettere da parte il tempo per farlo. I passaggi seguenti dovrebbero contribuire a rendere questo il più indolore possibile if e se no, c’è un “omaggio” verso la fine che vorrai afferrare.
Inizia con un contorno.
Prima di digitare le procedure e le definizioni, considerare la struttura del documento. Quali sono gli argomenti che sarà facile per il personale da seguire? E quale struttura sarà facile per te aggiornare nel tempo?
Spoiler: questo diventa il tuo sommario!
Per example…my il manuale Salesforce del team è suddiviso principalmente da oggetti. Ma a seconda della configurazione, suddividere gli argomenti per reparto o funzione può avere più senso.
Inizia larga. Poi, stretto.
Il manuale è destinato ad avere dettagli specifici e istruzioni passo-passo. Fondamentalmente, tutte le cose che i nostri colleghi continuano a dimenticare.
Ma una buona documentazione fornirà anche una visione utile e panoramica di come è organizzato il tuo sistema & perché. Tienilo a mente mentre pianifichi il tuo schema nel passaggio 1.
ps Consiglio vivamente di diagrammare il vostro modello di dati. È possibile utilizzare uno strumento gratuito come Google Disegni, o costruire qualcosa in un documento Word o Powerpoint (utilizzando forme & linee). Non deve essere di fantasia!
Definisci tutti i tuoi dati.
Ogni risorsa tecnologica nel tuo database è una manifestazione di qualche “cosa” della vita reale: che si tratti di una persona (donatori, volontari, ecc.), transazione (donazione, concessione, ecc..), o partnership (consegna del programma).
Una buona documentazione colmerà il divario tra il reale e il tecnico, definendo ciò che i tuoi oggetti & campi rappresentano nel mondo reale.
Meta, lo so.
Istruisci i tuoi utenti.
Il manuale utente dovrebbe fare due cose: definire e istruire.
Se il personale ha bisogno di eseguire attività nel database-inserimento dati, aggiornamenti dei dati, anche la ricerca-aiutarli includendo istruzioni passo – passo per quelle cose.
Suggerimento: Liste numerate & frasi brevi sono tuoi amici qui.
Scrivi tutto una volta. Quindi tagliare, ripetutamente.
Conosciamo tutti il dolore di leggere un manuale lungo, prolisso e soffocato nel testo. Risparmiate i vostri colleghi. Batti quella prima bozza e pianifica di dedicare molto tempo a tagliarla.
Perché? Perché meno è di più. E ci vuole tempo per mettere insieme la documentazione che è completa ed efficace, pur essendo concisa.
ps Non sto dicendo di tagliare le cose per brevità. Sto dicendo che la documentazione concisa è un’arte che non atterra al primo tentativo.
Fare uso di spazio bianco.
Pensa a questo in termini di UX (esperienza utente). Allo stesso modo in cui ti interessa che il tuo database sia user-friendly, vuoi anche che il tuo manuale sia facile da navigare.
Più spazio bianco c’è – la spaziatura tra/intorno al testo – meglio è. Considera anche la dimensione del carattere, l’altezza della linea e la spaziatura dei punti.
Usa solo screenshot dove devi.
Gli screenshot sono fantastici. Perché spiegare qualcosa a qualcuno quando si può mostrare loro, pure?
Ma personalmente credo che siano un po ‘ una trappola. Almeno quando si tratta di documentazione.
Pensaci. Se qualcosa cambia nell’interfaccia del tuo sistema, dovrai ri-afferrare e sostituire quelle immagini. Possono anche distrarre dalle tue istruzioni scritte, specialmente se ti lasci trasportare.
Ecco perché li uso principalmente per evidenziare qualcosa che i miei utenti potrebbero altrimenti perdere.
🌟 Un’altra cosa che potrebbe aiutare….
Ora che abbiamo i nostri passi, è il momento di iniziare a costruire! Per aiutarti, ho creato un modello di manuale utente che sto condividendo con chiunque lo desideri – per Microsoft Word o Google Docs!
Tutto ciò che serve è un indirizzo email. Per check it out e afferrare la vostra copia, seguire questo link.
Dal momento che questo è un blog di database, una breve nota! Con la firma per ricevere il modello, ti verrà anche aggiunto alla lista e-mail del mio blog (che non ho mai condividere con terzi). Mando aggiornamenti bimestrali e annunci occasionali, che si può opt-out in qualsiasi momento.