miten luoda käyttöohje Tietokannallesi (7 vaihetta)
Alrighty! Kuka innostuu puhumaan käyttöohjeista?
ymmärrän. Mutta jos olet kuten minä, niin olet samaa mieltä siitä, että prosessien dokumentointi & järjestelmät ovat välttämättömiä kaikille voittoa tavoittelemattomille. Pitää vain löytää aikaa tehdä se.
ja miksi emme? Dokumentointi säästää aikaa pitkällä aikavälillä. Se säästää meidät tarpeettomilta kokouksilta & vianmääritys, antamalla henkilökunnalle mahdollisuuden löytää omat vastauksensa.
puhumattakaan siitä, että se on hemmetin hyvä taito. Ja se on ratkaisevaa oman työn jatkamisen kannalta, jos & org eroaa.
yritä varata aikaa tähän. Vaiheet alla pitäisi auttaa tekemään tästä mahdollisimman kivuton … ja jos ei, siellä on ”freebie” loppua kohti haluat napata.
Aloita hahmotelmalla.
ennen kuin kirjoitat ohjeita ja määritelmiä, harkitse asiakirjasi rakennetta. Mitkä ovat aiheita, joita henkilökunnan on helppo seurata? Ja mikä rakenne on helppo päivittää ajan myötä?
juonipaljastus: tästä tulee Sisällysluettelosi!
example…my Teamin Salesforce-käsikirja on hajotettu pääosin esineiden mukaan. Mutta riippuen setup, jakaminen aiheita osastoittain tai toiminto voi olla järkevämpää.
aloita leveästi. Sitten kapea.
käsikirjassa on varmasti tarkat yksityiskohdat ja vaiheittaiset ohjeet. Periaatteessa kaikki asiat, jotka kollegamme aina unohtavat.
mutta hyvä dokumentointi antaa myös hyödyllisen, lintuperspektiivisen kuvan siitä, miten järjestelmäsi on järjestetty & miksi. Pidä tämä mielessä, kun suunnittelet ääriviivat vaiheessa 1.
s. suosittelen diagrammia tietomalliisi. Voit käyttää ilmaista työkalua, kuten Google Drawings, tai rakentaa jotain Word tai Powerpoint doc (käyttäen muotoja & riviä). Ei sen tarvitse olla hieno!
Määrittele kaikki tietosi.
jokainen tietokantasi tekninen voimavara on jonkin tosielämän ”asian” ilmentymä: olipa kyseessä henkilö (lahjoittajat, vapaaehtoiset jne.), transaktio (lahjoitus, apuraha jne..), tai kumppanuus (ohjelmatoimitus).
hyvä dokumentaatio kuroo umpeen todellisen ja teknisen kuilun määrittelemällä, mitä objektisi & kentät edustavat todellisessa maailmassa.
Meta, tiedän.
ohjeistaa käyttäjiä.
käyttäjän oppaassa pitäisi tehdä kaksi asiaa: määritellä ja ohjeistaa.
jos henkilökunnan täytyy suorittaa tehtäviä tietokannassasi-tietojen syöttämistä, tietojen päivittämistä, jopa hakua-auta heitä sisällyttämällä niihin vaiheittaiset ohjeet.
Vihje: numeroidut listat & lyhyet lauseet ovat ystäväsi tässä.
kirjoita kaikki kerran. Sitten leikata, toistuvasti.
me kaikki tunnemme pitkällisen, sanavalmiin ja tekstiin tukahdutetun käsikirjan lukemisen tuskan. Säästä kollegasi. Paukuta se ensimmäinen luonnos ja suunnittele käyttäväsi paljon aikaa sen siistimiseen.
miksi? Koska vähemmän on enemmän. Ja se vie aikaa koota dokumentaatio, joka on kattava ja tehokas, mutta silti ytimekäs.
p. S. En käske leikata asioita pois lyhyyden vuoksi. Väitän, että tiivis dokumentointi on taidetta – sellaista, joka ei laskeudu ensimmäisellä yrittämällä.
Hyödynnä valkoista tilaa.
ajattele tätä UX: n (käyttäjäkokemuksen) kannalta. Samalla tavalla kuin välität tietokantasi käyttäjäystävällisyydestä, haluat myös manuaalisi olevan helppo selata.
mitä enemmän valkoista tilaa on – väli tekstin välillä/ympärillä – sen parempi. Harkitse myös fonttikokoa, viivan korkeutta ja luotiväliä.
käytä ruutukaappauksia vain silloin, kun on pakko.
kuvakaappaukset ovat fantastisia. Miksi selittää jollekin jotain, kun voi näyttää heillekin?
mutta itse uskon, että ne ovat vähän ansa. Ainakin dokumentoinnin suhteen.
ajattele sitä. Jos jotain muutoksia järjestelmän käyttöliittymä, sinun täytyy uudelleen napata ja korvata ne kuvat. Ne voivat myös kääntää huomion pois kirjallisista ohjeistuksistasi, varsinkin jos innostut liikaa.
siksi käytän niitä lähinnä korostaakseni jotain, mitä käyttäjäni muuten jäisivät kaipaamaan.
🌟 vielä yksi asia, joka voisi auttaa….
nyt kun on askeleet, on aika aloittaa rakentaminen! Auttaa, olen luonut käyttöohjeen malli, jonka jaan kaikille, jotka haluavat sen-Microsoft Word tai Google Docs!
tarvitset vain sähköpostiosoitteen. Voit tarkistaa sen ja napata kopion tästä linkistä.
koska tämä on tietokanta blogi, yksi nopea huomautus! Rekisteröitymällä saadaksesi mallin, sinut lisätään myös blogini sähköpostilistalle (jota en koskaan jaa kolmansien osapuolten kanssa). Lähetän joka toinen kuukausi päivityksiä ja satunnaisia ilmoituksia, joista voit kieltäytyä milloin tahansa.