Så skriver du om knappar på skärmen

Skriva om gränssnitt

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!

Dela på facebook
Dela på twitter
Dela på linkedin
Dela på email

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

Buffe med mat

Därför ska du skriva manualen som en buffé

Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord

Instruktioner för att laga soppa

User stories ger dig rätt instruktioner (del 2)

User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva. Välkommen till

Läsare av teknisk dokumentation

Fixa dokumentationen med user stories (del 1)

User stories kan ge dig en flygande start när du ska skriva teknisk dokumentation, särskilt manualer av olika slag. Det gäller oavsett om det är grundläggande manualer till slutanvändare, integrationsinstruktioner

Musfälla

Trick för att locka information ur utvecklare

Att få fram underlag till teknisk dokumentation är verkligen en utmaning. Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden

Tips till dig som skriver lathund i affekt

Behöver dina kunder en lathund för er produkt? Eller behöver ni själva en intern lathund på kontoret för att komma tillrätta med reseräkningarna? Lathundar kan vara många olika saker. Allt

Gunilla Svanfeldt Omslag

Samtycke till marknadsföring

Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden. 

Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.

We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.