Träffa rätt med företagets dokumentation

Sara Török
  • Sara Török

Höga kvalitetsmål är lätta att sätta, men inte alltid lika lätta att leva upp till i längden. Om ni storsatsar på att uppgradera er dokumentation med bilder, index och interaktivitet, men inte har organisation, personal, tid och processer för att upprätthålla detta genom alla uppdateringar, så kommer fler och fler uppgifter blir felaktiga, inaktuella och otillräckliga för varje uppdatering. Det går snabbt utför med kvaliteten om målet var alltför ambitiöst från början.

Förledande förebilder

Alla avancerade förebilder vi ser omkring oss kan bidra till alltför orealistiska mål. Tänk på att de lösningar som syns hos Apple, Google, Microsoft Office och andra kända leverantörer är framtagna av stora team som utvecklar och underhåller verktyg, sajter och appar. Att det går att göra betyder inte att det är realistiskt att ni ska bygga det – i varje fall inte i en första omgång.

Lönande långsiktighet

Vid planeringen av nya funktioner måste hänsyn tas till nuvarande och framtida kapacitet.

Det är lätt att bli överentusiastisk vid bygge av en ny lösning och lägga till alla möjliga finesser som man sedan inte har möjlighet att hålla igång. Börja med en baslösning och bygg sedan vidare. Lägg upp arbetet så att det går att utöka senare och inte blir låst vid denna första nivå.

Exempel 1: Onlinehjälp

Ni skapar en detaljerad och ambitiös onlinehjälp där man kan klicka på F1 för att få hjälptexter för just det fönstret, menyn eller listvalet man befinner sig på. Kan utvecklare och skribenter hålla tjänsten uppdaterad och testad? Det är ett stort åtagande från att inte ha haft onlinehjälp alls. Snart slutar användarna att söka i hjälpen eftersom det är för osäkert om man hittar något om de senaste funktionerna och om uppgifterna är korrekta.

Lägg funktionaliteten på en nivå som ni klarar av att underhålla, och planera för utökningar allt eftersom. Kanske räcker det till att börja med att få upp hjälp för rätt modul eller bara innehållsförteckning och sökfunktion för hjälpen?

Exempel 2: Webbplats

Ni lägger upp en ny webbplats via ett verktyg. Det ingår funktioner för kalender och blogg. Så då lägger ni upp dem på förstasidan. Efter ett år finns 3 inget nytt att lägga in eftersom ni egentligen inte har några evenemang och ingen som ägnar sig åt relevant bloggande.

Om man inte har regelbundet material till en blogg eller en kalender så ska man inte ha den funktionen på hemsidan. Det ser bara dött ut. Och det hjälper verkligen inte att då och då klämma in ett “Nu är det vår igen och det uppskattar både vi här på Olssons plåt och våra nöjda kunder”. Lägg upp de få nyheter ni har direkt på förstasidan i stället för att skapa listor som inte kan fyllas.

Exempel 3: Snygga foton

Ni tar in en proffsfotograf som tar fram fina högupplösta bilder på varenda konstruktionsdetalj ur alla vinklar och genom alla monterings- och underhållsmoment.

Hur ska ni hålla det uppdaterat vid ändringar eller tillägg av delar? Risken är att det inte blir uppdaterat alls eller att vissa bilder kommer att hålla mycket lägre kvalitet än resten. Eller att vissa moment hoppas över då man bara tar bort den inaktuella bilden utan att ersätta den. Eller ännu värre: att uppdaterade instruktioner skjuts på framtiden för att det tar tid och kostar pengar att få fram nya bilder.

Om ni inte själva har personal med kunskap, verktyg och tid att hålla fotobanken uppdaterad kanske ni ska nöja er med tjusigare foton på generella saker och översikter och lösa resten med någon bildteknik som ni klarar av att producera själva.

Sammanfattningsvis

Tänk igenom innan: Vad ska vi ha och varför och måste vi ha allt med en gång? Att funktionen finns tillgänglig eller att många andra har den är inte tillräckliga skäl för att ni ska börja använda den. Satsa på kvalitet före kvantitet om det ska hålla i längden.

Om Dokumentera

Dokumentera är ett ambitiöst och växande konsultbolag specialiserat på att skriva, analysera och organisera information och teknisk dokumentation. Vi gör våra kunders information och tekniska dokumentation lättillgänglig och begriplig. Vi hjälper våra kunder att beskriva vad de säljer samt hur de fungerar internt som företag och organisation. Det omfattar allt från produkter och tjänster till IT-system, intern styrande dokumentation samt att skapa en effektiv informationshantering. Vi arbetar som tekniska skribenter, content managers, projektledare och dokumentsamordnare och kan bistå i hela processen från förstudie och analys till produktion, kvalitetssäkring och utbildning. Sedan Dokumentera startade sin verksamhet 2007 har vi hjälpt ett stort antal nöjda företag och organisationer i olika branscher med kvalitativ dokumentation för både internt och externt bruk. Läs mer om vad vi kan göra för dig på www.dokumentera.se eller slå en signal till Henrik Rehmberg, tel 0709-727 337 så berättar han mer.