Hogyan hozzunk létre egy felhasználói kézikönyv az adatbázis (7 lépések)
rendben! Ki izgatottan beszél a felhasználói kézikönyvekről?
nézd, megértem. De ha olyan vagy, mint én, akkor egyetért azzal, hogy a & rendszerek dokumentálása elengedhetetlen minden nonprofit szervezet számára. Csak időt kell találni rá.
és miért ne tennénk? A dokumentáció hosszú távon időt takarít meg. Megkímél minket a felesleges találkozóktól & hibaelhárítás, azáltal, hogy felhatalmazza a személyzetet arra, hogy megtalálják a saját válaszaikat.
arról nem is beszélve, hogy ez egy rohadt jó készség. És elengedhetetlen a munka fenntartásához, ha & a szervezés elválik.
próbáljon erre időt szánni. Az alábbi lépések segítenek abban, hogy ez a lehető fájdalommentes legyen…és ha nem, akkor van egy “freebie” a vége felé, amit meg akarsz ragadni.
Kezdje egy vázlattal.
mielőtt beírná az eljárásokat és definíciókat, fontolja meg a dokumentum szerkezetét. Melyek azok a témák, amelyeket a személyzet könnyen követhet? És milyen struktúrát lesz könnyű frissíteni az idő múlásával?
Spoiler: ez lesz a Tartalomjegyzék!
a example…my a csapat Salesforce kézikönyvét elsősorban tárgyak bontják szét. De attól függően, hogy a Beállítás, felosztása témák osztály vagy funkció lehet több értelme.
kezdje széles. Akkor keskeny.
a kézikönyvnek konkrét részleteket és lépésről lépésre szóló utasításokat kell tartalmaznia. Alapvetően minden dolog, amit a kollégáink elfelejtenek.
de a jó dokumentáció is ad egy hasznos, madártávlatból, hogyan a rendszer szervezett & miért. Tartsa ezt szem előtt, amikor az 1.lépésben megtervezi a vázlatot.
p.s. nagyon ajánlom az adatmodell ábrázolását. Használhat egy ingyenes eszközt, például a Google rajzokat, vagy építhet valamit egy Word vagy Powerpoint dokumentumba (alakzatok & vonalak használatával). Nem kell, hogy divatos legyen!
határozza meg az összes adatot.
az adatbázis minden technikai eszköze valamilyen valós “dolog” megnyilvánulása: legyen szó személyről (adományozók, önkéntesek stb.), tranzakcióról (adomány, támogatás stb..), vagy partnerség (program kézbesítés).
a jó dokumentáció áthidalja a szakadékot a valós és a technikai között azáltal, hogy meghatározza, hogy az objektumok & mezői mit képviselnek a tényleges világban.
Meta, tudom.
utasítsa a felhasználókat.
a felhasználói kézikönyvnek két dolgot kell tennie: definiálni és utasítani.
ha a személyzetnek feladatokat kell végrehajtania az adatbázisban – adatbevitel, adatfrissítések, akár keresés–, segítsen nekik azáltal, hogy lépésről-lépésre utasításokat ad ezekhez a dolgokhoz.
tipp: számozott listák & rövid mondatok a barátod itt.
írj mindent egyszer. Ezután vágja le többször.
mindannyian tudjuk, milyen fájdalmas egy hosszadalmas, bőbeszédű és szövegbe fojtott kézikönyvet olvasni. Kímélje meg a kollégáit. Dobd ki az első vázlatot,és tervezd, hogy sok időt töltesz a vágással.
miért? Mert a kevesebb több. És időbe telik az átfogó és hatékony dokumentáció összeállítása, miközben tömör.
UI.nem azt mondom, hogy a rövidség kedvéért vágjunk ki dolgokat. Azt mondom, hogy a tömör dokumentáció művészet – olyan, amely nem az első próbálkozásra érkezik.
használja ki a fehér teret.
gondolj erre az UX (felhasználói élmény) szempontjából. Ugyanúgy érdekel, hogy az adatbázis felhasználóbarát legyen, azt is szeretné, ha a kézikönyv könnyen böngészhető lenne.
minél több fehér szóköz van – a szöveg közötti/körüli távolság – annál jobb. Vegye figyelembe a betűméretet, a vonal magasságát és a golyó távolságát is.
csak akkor használja a képernyőképeket, ahol kell.
a képernyőképek fantasztikusak. Miért magyarázna el valamit valakinek, ha meg is tudja mutatni?
de én személy szerint úgy gondolom, hogy egy kis csapda. Legalábbis ami a dokumentációt illeti.
Gondolj bele. Ha valami megváltozik a rendszer felületén, akkor újra meg kell ragadnia és ki kell cserélnie ezeket a képeket. Elvonhatják az írásbeli utasításokat is, különösen, ha elragadtatja magát.
ezért elsősorban arra használom őket, hogy kiemeljek valamit, amit a felhasználók egyébként hiányolhatnak.
🌟 még egy dolog, ami segíthet….
most, hogy megvannak a lépéseink, itt az ideje elkezdeni az építkezést! Segítségül létrehoztam egy felhasználói kézikönyv sablont, amelyet mindenkivel megosztok – aki akarja-a Microsoft Word vagy a Google Docs számára!
csak egy e-mail címre van szüksége. Hogy nézd meg, és fogd meg a másolatot, kövesse ezt a linket.
mivel ez egy adatbázis blog, Egy gyors megjegyzés! Ha feliratkozik a sablon fogadására, akkor felkerül a blogom e-mail listájára is (amelyet soha nem osztok meg harmadik felekkel). Kéthavonta küldök frissítéseket és alkalmi bejelentéseket, amelyekről bármikor leiratkozhat.