jak vytvořit uživatelskou příručku pro vaši databázi (7 kroků)
Alrighty! Kdo je nadšený, že mluví o uživatelských příručkách?
Hele, chápu to. Ale pokud jste jako já, pak souhlasíte s tím, že dokumentování procesů & systémy jsou nezbytné pro každou neziskovou organizaci. Je to jen otázka nalezení času na to.
a proč bychom ne? Dokumentace nám dlouhodobě šetří čas. Ušetří nás od zbytečných schůzek & řešení problémů tím, že zmocní zaměstnance, aby našli své vlastní odpovědi.
nemluvě, je to zatraceně dobrá dovednost mít. A to je pro udržení vaší práce klíčové, pokud byste se měli věnovat orgánům.
zkuste vyčlenit čas na to. Níže uvedené kroky by měly pomoci, aby to tak bezbolestné, jak je to možné…a pokud ne, tam je“ freebie “ ke konci budete chtít chytit.
začněte s obrysem.
než zadáte postupy a definice, zvažte strukturu dokumentu. Jaká témata budou zaměstnanci snadno sledovat? A jakou strukturu budete v průběhu času snadno aktualizovat?
Spoiler: toto se stane vaším obsahem!
pro example…my týmová příručka Salesforce je rozdělena hlavně podle objektů. Ale v závislosti na vašem nastavení, rozdělení témat podle oddělení nebo funkce může mít větší smysl.
začněte široce. Pak, úzký.
váš manuál musí obsahovat konkrétní podrobnosti a podrobné pokyny. V podstatě všechny věci, na které naši kolegové stále zapomínají.
ale dobrá dokumentace také poskytne užitečný pohled z ptačí perspektivy na to, jak je váš systém organizován & proč. Mějte to na paměti při plánování obrysu v kroku 1.
p. s. vřele doporučuji diagramovat váš datový model. Můžete použít bezplatný nástroj, jako je Google Drawings, nebo vytvořit něco v aplikaci Word nebo Powerpoint doc (pomocí tvarů & řádků). Nemusí to být fantazie!
Definujte všechna svá data.
každý technický majetek ve vaší databázi je projevem nějaké skutečné „věci“: ať už je to osoba (dárci, dobrovolníci atd.), transakce(dar, grant atd..), nebo partnerství (program delivery).
dobrá dokumentace překlene mezeru mezi skutečným a technickým tím, že definuje, co vaše objekty & pole představují ve skutečném světě.
Meta, já vím.
Poučte své uživatele.
vaše uživatelská příručka by měla dělat dvě věci: definovat a instruovat.
pokud zaměstnanci potřebují provádět úkoly ve vaší databázi-zadávání dat, aktualizace dat, dokonce i vyhledávání-pomozte jim tím, že zahrnete podrobné pokyny pro tyto věci.
Tip: číslované seznamy & krátké věty jsou vaším přítelem zde.
napište všechno jednou. Poté opakovaně ořízněte.
všichni známe bolest při čtení příručky, která je zdlouhavá, rozvláčná a dusená v textu. Ušetřete své kolegy. Vyhoďte ten první návrh, a plánujte strávit spoustu času ořezáváním.
proč? Protože méně je více. A sestavení dokumentace, která je komplexní a efektivní, vyžaduje určitý čas a přitom je stručná.
p. s. neříkám, abych věci vyřízl kvůli stručnosti. Říkám, že stručná dokumentace je umění, které nepřistane na první pokus.
využijte bílé místo.
myslete na to z hlediska UX (user experience). Stejně jako vám záleží na tom, aby vaše databáze byla uživatelsky přívětivá, také chcete, aby se vaše příručka snadno procházela.
čím více prázdného místa je-mezery mezi / kolem vašeho textu-tím lépe. Zvažte také velikost písma,výšku řádku a rozteč odrážek.
snímky obrazovky používejte pouze tam, kde musíte.
screenshoty jsou fantastické. Proč někomu něco vysvětlovat, když mu to můžete také ukázat?
ale já osobně se domnívám, že jsou tak trochu past. Alespoň pokud jde o dokumentaci.
Přemýšlejte o tom. Pokud se něco změní v rozhraní vašeho systému, budete muset tyto obrázky znovu uchopit a nahradit. Mohou také odvrátit pozornost od vašich písemných pokynů, zejména pokud se necháte unést.
proto je používám hlavně k zvýraznění něčeho, co by moji uživatelé jinak mohli chybět.
🌟 ještě jedna věc, která by mohla pomoci….
Nyní, když máme naše kroky, je čas začít stavět! Abych vám pomohl, vytvořil jsem šablonu uživatelské příručky, kterou sdílím s kýmkoli – kdo ji chce-pro Microsoft Word nebo Dokumenty Google!
vše, co potřebujete, je e-mailová adresa. Chcete-li to zkontrolovat a chytit svou kopii, klikněte na tento odkaz.
protože se jedná o databázový blog, jedna rychlá poznámka! Přihlášením k odběru šablony budete také přidáni do e-mailového seznamu mého blogu(který nikdy nesdílím s třetími stranami). Posílám dvouměsíční aktualizace a příležitostná oznámení, ze kterých se můžete kdykoli odhlásit.