Hem | Produkter | Verktyg | Metodik | SEO | Hyra teknikinformatör

  • Struktur
  • Medier
  • Filformat
  • Språk
  • Länkar

Produkter

Teknikinformatörens leverabler

Information om produkter och tjänster kan komma i många former. Formen bör anpassas efter användarnas behov. Det är bättre att det fungerar än att det är flashigt.

Här går vi igenom de vanligaste produkterna som teknikinformatörer brukar lämna ifrån sig till sina arbetsgvare eller uppdragsgivare. Det finns förstås andra också.

Användamanual
Den klassiska formen för teknikinformation. Innehåller information som ska hjälpa produktens slutanvändare att utföra sina arbetsuppgifter med hjälp av produkten.

Man brukar skilja på två typer av användarmanual:

  • Bruksanvisning – Tydliga och konkreta steginstruktioner som lotsar användaren genom en process eller ett arbetsflöde
  • Referensguide – Uppslagsverk som listar alla ingående delar i produkten, t.ex. skruvar och muttrar eller fönster och menyer, ofta i alfabetisk ordning

Olika typer av användare kan behöva olika information, antingen i olika manualer eller i olika delar av samma manual. De har kanske olika arbetsuppgifter, olika behörighet och olika kunskap.

Exempel på användartyper som kan behöva samsas i ett system kan vara handläggare, chefer och systemadministratörer.

Installationsmanualer och monteringsanvisningar
Innan man kan använda produkten kanske den måste installeras eller monteras. Ofta är det inte slutanvändaren som gör det, utan särskild personal.

De är ofta mycket kunniga inom det aktuella området och man kanske kan bespara dem upplysningar som de anser för självklara. I gengäld kan manualen behöva ge en del väldigt specifik och kanske tekniskt avancerad information. Då är det viktigt att den framställs på ett glasklart och lättolkat sätt.

När det gäller mjukvara kan det vara bra om installationsmanualen inte enbart finns som onlinehjälp. Normalt sett har man ju inte tillgång till hjälpen förrän produkten är installerad.

Det är grundläggande att teknikinformatören eller teknikskribenten vet vad det handlar om. Antingen genom egen teknisk kompetens eller genom ett bra samarbete med teknikerna.

Driftsmanualer och skötselanvisningar
Efter installationen kräver de flesta produkter och system regelbunden skötsel. Ofta utförs den av personer som varken är slutanvändare eller installatörer. Ytterligare en grupp vars arbetsuppgifter och ingångskunskap teknikinformatören behöver sätta sig in i.

Just den här typen av manual kan ställa en del speciella krav på format och media. Man kan till exempel tänka sig att en underhållstekniker som reser runt mellan många installationer och jobbar i smutsiga miljöer helst inte vill släpa på ett pärmverk. Kanske en bärbar terminal med stor text fungerar bättre, och då måste informationen utformas med tanke på det speciella formatet.

Det är bra om den typen av krav blir kända tidigt i utvecklingsarbetet så att teknikinformatören inte lägger tid på att producera historiens snyggaste affisch. Kraven på dokumentationen bör hanteras på samma sätt som kraven på systemet i övrigt.

Dokumentationen kan mycket väl ses som ett delsystem. Då kanske det blir lättare att undvika det vanliga misstaget att kalla in teknikinformatören alldeles för sent.

API-manual
En manual för dem som programmerar mot ett visst API. Ofta ingår både en användarmanual med instruktioner om hur man utformar sina anrop osv. och en referensguide som listar de objekt och parametrar som finna tillgängliga.

Med tanke på hur mycket som kan förändras i ett API (eller i det underliggande systemet som man kommer åt via API:et) kan det vara klokt att låta API-manualen genereras från källkoden, i alla fall referensdelen. På så sätt blir alla detaljer korrekta, förhoppningsvis.

Konkreta kodexempel är väldigt nyttiga. Återigen krävs att teknikinformatören jobbar nära ihop med utvecklarna.

Onlinehjälp
Man ska ha klart för sig att onlinehjälp egentligen är ett presentationsformat snarare än en typ av manual. Det är till exempel inte alls ovanligt att både användarmanualer och API-manualer levereras som onlinehjälpsystem. En modern form av teknikinformation.

Dessutom vore det kanske bättre att kalla det för skärmhjälp, eftersom det som kännetecknar onlinehjälpen är att den visas på datorskärmen. Däremot behöver den inte ligga online utan kan ofta med fördel ligga lokalt på hårddisken.

Själva poängen med en onlinehjälp är möjligheten att använda hypertextlänkar för att skapa lättillgänglig information. En manual blir inte till en bra onlinehjälp bara för att man spar den som pdf och lägger den på nätet.

När man gör en onlinehjälp är det principerna för läsbarhet på webben som bör vara vägledande. Man måste beakta läsarens otålighet vid datorn, och motviljan mot stora grå textmassor.

Tydliga och informativa mellanrubriker eller etiketter (labels) är viktigt, liksom att enskilda sidor inte är alltför långa och kräver massor av rullning (scrollning).

Men man bör kanske inte överdriva åt andra hållet heller, då ett system med tusentals superkorta avsnitt kan bli hopplöst tungrott och svårnavigerat.

Stycken bör förmodligen avdelas på andra grunder än i tryckt text, mer för att uppnå en luftig text med fler ”handtag” än att hålla samman logiska enheter.

Precis som här.

Lathund
En lathund är ett litet dokument som är praktiskt att ha vid datorn eller i fickan och som sammanfattar vanliga moment eller data för en användare som redan vet hur systemet eller produkten fungerar. Här gäller det verkligen för teknikinformatören att förstå användarens behov och förkunskaper.