3 vanliga misstag i manualer

Kvinna med stålhand
Beskriv maskinen eller systemet optimalt, men bli inte själv en maskin.

Alla har väl någon gång skakat på huvudet åt en manual och inte sett någon mening med att läsa den.

Jag misstänker att många företag låter en duktig produktutvecklare, processingenjör eller programmerare ta hand om dokumentationen. Någon som varit med och utvecklat eller tagit fram produkten och vet hur den fungerar.

Det kan vara ett stort misstag.

Den som är duktig på programsekvenser eller reglerteknik behöver inte alls vara bra på att beskriva hur produkten ska installeras, förberedas, startas, användas, justeras, optimeras, stoppas, nödstoppas, rengöras och underhållas.

Det krävs både helikopterperspektiv och sinne för detaljer när upplägget ska planeras. Många fastnar dock i det ena eller andra eller blir för trötta av detaljer.

En manual ska innehålla minsta möjliga mängd information. Allt ska optimeras, så varje detalj som kan förenas med en annan detalj på en genomtänkt plats i manualen bidrar till ett lättläst och logiskt resultat.

Det går inte att separera strukturen från detaljerna vid planering av upplägget. Detaljer ska presenteras korrekt, i rätt ögonblick och i rätt ordning. De ska inte upprepas på olika ställen eller i olika sammanhang, om de kan samlas i en minsta gemensamma nämnare.

Det är ett stort misstag att inte beskriva detaljer korrekt eller i rätt ordning, när detaljer trots allt måste ingå. En felaktigt formulerad, upprepad eller placerad detalj lurar användaren. Det leder till missnöjda användare och ökar risken för missförstånd och material- eller personskador.

Ett företag som producerar undermåliga texter kan få målgruppen att fråga sig vad företaget mer kan tänkas slarva med.

Låt oss sammanfatta dessa 3 vanliga misstag:

  1. “Skribenten” är expert på annat än att skriva. Exempelvis på produkten i sig.
  2. Skribenten saknar förmåga att inta helikopterperspektiv eller fokusera på detaljer.
  3. Skribenten saknar förmåga att strukturera, optimera och/eller presentera informationen.