På mitt första jobb som teknisk skribent hade jag bekymmer med en massa saker. Ett av mina bekymmer var hur jag skulle skriva om knappar och andra element i gränssnittet. Resultatet blev en väldig massa citationstecken runt knappnamnen.
Klicka på ”Spara”. Då visas ”Filen sparad”-meddelandet och ikonen för ”Status” blir grön.
De första två fallen funkar ju även om det kanske blir stökigt med alla citationstecken (eller ”fnuttar”, som jag brukar säga). Mitt problem med status-ikonen var att det inte stod ”Status” någonstans, det var bara en rund plupp som fick olika färg beroende på status. Hur skulle jag benämna den?
Knappar som verb
Jag brottades även med hur jag skulle få in knappnamnen i meningen på ett bra sätt.
Du kan ”Spara” filen.
Var det fiffigt eller inte? Att liksom baka in knappnamnet som ett verb i meningen? Det blev dock problem med böjningarna.
När du har ”Sparat” filen…
Knappen hette ju Spara, inte Sparat.
Lösningen
Lösningen lärde jag mig från erfarna tekniska skribenter på mitt nästa jobb. Tricket är att hantera all text som står på skärmen som software text. Istället för fnuttar så bestämmer ni er för att alla knappnamn, eller andra textsträngar som förekommer i gränssnittet, får en viss typografisk markering. Ni kan till exempel skriva knappnamnen i fetstil. Och böj aldrig knappnamnen! Allt du taggar som software text måste stå EXAKT som det står i gränssnittet.
Klicka på Spara. Då visas meddelandet Filen sparad och ikonen för status blir grön.
Notera att jag inte fetmarkerade ordet status, eftersom den texten inte står i gränssnittet. Om du tycker att det blir otydligt kan du komplettera med en bild, eller hänvisa till en beskrivning av status-ikonerna om du har en sådan.
Software text och översättning
Om ni översätter manualen är taggningen extra värdefull. Om ni inte översätter gränssnittet utan bara manualen, så ger ni instruktioner till översättningsfirman om att det som står markerat med software text inte ska översättas.
Om ditt gränssnitt och den ursprungliga manualen är på engelska blir resultatet så här:
Originaltext: Click Save.
Översättning: Klicka på Save.
Om ni översätter både gränssnitt och manual så behöver ni förse manual-översättaren med den termlista som gäller för texterna i gränssnittet. Annars finns det risk att olika översättare väljer olika översättningar för knapparna.
Gratis webbkurs
Vill du komma igång med att styra upp er tekniska dokumentation? Gå gärna min gratis webbkurs där jag har samlat de frågor som brukar dyka upp. (Kursen är nu stängd.)
Registrera dig gärna på mitt nyhetsbrev så informerar jag dig om när det kommer nya kurser!
