• Articles
• admin

Alrighty! Vem är glada att prata användarmanualer?

jag fattar. Men om du är som jag, då håller du med om att dokumentera processer & system är viktigt för alla ideella organisationer. Det handlar bara om att hitta tid att göra det.

och varför skulle vi inte? Dokumentation sparar oss tid på lång sikt. Det sparar oss från onödiga möten & felsökning, genom att ge personalen möjlighet att hitta sina egna svar.

för att inte tala om, det är en bra färdighet att ha. Och det är viktigt att upprätthålla ditt arbete, om du & din organisation delar vägar.

försök att avsätta tid för att göra detta. Stegen nedan bör hjälpa till att göra detta så smärtfritt som möjligt…och om inte, finns det en ”freebie” mot slutet du vill ta tag i.

börja med en skiss.

innan du skriver ut procedurer och definitioner, överväga strukturen i ditt dokument. Vilka är de ämnen som kommer att vara lätta för personalen att följa? Och vilken struktur blir lätt för dig att uppdatera över tiden?

Spoiler: detta blir din Innehållsförteckning!

för example…my teamets Salesforce manual bryts isär främst av objekt. Men beroende på din inställning kan det vara mer meningsfullt att dela ämnen efter avdelning eller funktion.

börja bred. Sedan smal.

din manual är bunden att ha specifika detaljer och steg-för-steg-instruktioner. I grund och botten, alla saker som våra kollegor glömmer.

men bra dokumentation kommer också att ge en bra, fågelperspektiv av hur ditt system är organiserat & varför. Tänk på det när du planerar din skiss i steg 1.

p.s. jag rekommenderar att Diagram din datamodell. Du kan använda ett gratis verktyg som Google ritningar, eller bygga något i ett Word-eller Powerpoint-dokument (med former & linjer). Behöver inte vara fancy!

definiera alla dina data.

varje teknisk tillgång i din databas är en manifestation av någon verklig ”sak”: om det är en person (givare, volontärer osv…), transaktion (donation, bidrag etc..), eller partnerskap (programleverans).

bra dokumentation kommer att överbrygga klyftan mellan det verkliga och det tekniska, genom att definiera vad dina objekt & fält representerar i den verkliga världen.

Meta, jag vet.

instruera dina användare.

din användarmanual ska göra två saker: definiera och instruera.

om personalen behöver utföra uppgifter i din databas – datainmatning, datauppdateringar, även sökning – hjälp dem genom att inkludera steg-för-steg-instruktioner för dessa saker.

tips: numrerade listor & korta meningar är din vän här.

skriv allt en gång. Trimma sedan, upprepade gånger.

vi vet alla smärtan av att läsa en manual som är lång, ordig och kvävd i text. Skona dina kollegor. Bang ut det första utkastet, och planerar att spendera mycket tid på att trimma ner det.

varför? Eftersom mindre är mer. Och det tar tid att sätta ihop dokumentation som är omfattande och effektiv, samtidigt som den är kortfattad.

PS Jag säger inte att klippa ut saker för korthetens skull. Jag säger att kortfattad dokumentation är en konst-en som inte landar vid första försöket.

använd vitt utrymme.

Tänk på detta när det gäller UX (användarupplevelse). På samma sätt som du bryr dig om att din databas är användarvänlig, vill du också att din manual ska vara lätt att bläddra.

ju mer vitt utrymme det finns-avståndet mellan / runt din text – desto bättre. Tänk också på din teckenstorlek, linjehöjd och kulaavstånd.

använd bara skärmdumpar där du måste.

Skärmdumpar är fantastiska. Varför förklara något för någon när du kan visa dem, för?

men jag tror personligen att de är lite av en fälla. Åtminstone när det gäller dokumentation.

Tänk på det. Om något ändras i systemets gränssnitt måste du ta tag i och ersätta dessa bilder. De kan också distrahera från dina skriftliga instruktioner, speciellt om du blir borttagen.

därför använder jag dem främst för att markera något som mina användare annars skulle sakna.

🌟 en sak till som kan hjälpa….

nu när vi har våra steg är det dags att börja bygga! För att hjälpa till har jag skapat en användarmanualmall som jag delar med alla som vill ha den – för Microsoft Word eller Google Docs!

allt du behöver är en e-postadress. För att kolla in det och ta din kopia, följ den här länken.

eftersom det här är en databasblogg, en snabb anteckning! Genom att registrera dig för att få mallen kommer du också att läggas till i min Bloggs e-postlista (som jag aldrig delar med tredje part). Jag skickar varannan månad uppdateringar och tillfälliga meddelanden, som du kan välja bort när som helst.