Metlivi-bloggen

Så korrekturläser du tekniska termer, versalisering och översatta etiketter

När du granskar teknisk dokumentation ska du kontrollera varje term mot en uttrycklig termtabell i stället för att förlita dig på minnet eller en enda versaliseringsregel. Anteckna den godkända formen, stavningen och skiftläget som läsarna ska se, godtagbara varianter, bokstavliga kod- eller API-identifierare och eventuella översättningar som fortfarande väntar på ett beslut. Korrekturläs sedan löptext, gränssnittsetiketter och identifierare var för sig. Den här metoden fångar upp inkonsekvent terminologi och bevarar samtidigt namn och kod som måste återges exakt.

30 september 20264 min läsningAv Metlivi Editorial Team
Avsnitt 1

Varför kan inte en enda versaliseringsregel avgöra hur alla termer ska skrivas?

Stilguider ger användbara grundregler, men en produkt eller ett ämnesområde kan ha etablerade namn som kräver en annan behandling. Googles utvecklarguide rekommenderar standardiserad amerikansk engelska och meningsversaler i rubriker, listor och tabeller, samtidigt som officiella produktnamn och kodformer bevaras. Microsofts guide föredrar också meningsversaler, men anger uttryckligen att versaler ska användas för egennamn som företagets varumärken, produkter och tjänster. Den gemensamma grundregeln är en utgångspunkt, inte ett bevis på att en viss teknisk term är generisk. Googles riktlinjer för versalisering Microsofts riktlinjer för versalisering

En ordlista kan besvara en annan fråga än en allmän sida om versalisering: vilken stavning eller användning en viss redaktionell guide föredrar för specifika termer. Googles ordlista hänvisar till exempel läsarna till den ordbok som Google föredrar för uppslagsord som inte tas upp där, och skiljer mellan stilråd och kontroll av en teknisk definition i auktoritativ dokumentation. Den uppdelningen är användbar: redaktionell konsekvens och teknisk korrekthet behöver belägg från källor som lämpar sig för respektive fråga. Googles ordlista

Avsnitt 2

Vad ska ingå i en termtabell för korrekturläsning?

Skapa en rad för varje term som riskerar att ändras inkonsekvent eller felöversättas. Det här hypotetiska exemplet visar fälten och beslutslogiken; ”Sync token” och dess översättning är illustrativa och gör inte anspråk på att beskriva en verklig produkt eller godkänd terminologi.

Tabellens uppgift är att bevara beslut och deras begränsningar. En tillåten form med gemener ska inte i tysthet bli ett andra produktnamn; en identifierare ska inte ”rättas” för att överensstämma med löptexten; och en översättning som inte är avgjord ska fortsätta vara synligt olöst. Om en officiell källa strider mot en lokal ordlista ska du dokumentera konflikten och källan till det slutliga beslutet i stället för att slå ihop formerna till en oförklarad lista.

Term och omfattning — Begrepp, produktområde och målgrupp — Sync token; inställningsguide

Officiell form och belägg — Exakt godkänd form, källa och kontrollerad version eller datum — Sync token; produktordlista, version 3

Visningsform — Stavning och skiftläge i förklarande löptext och etiketter — Sync token

Tillåtna varianter — Former som är tillåtna i ett definierat sammanhang, med motivering — ”sync token” i generisk löptext, om ordlistan tillåter det

Bokstavliga identifierare — Exakt kod-, API-, kommando- eller gränssnittssträng som inte får skrivas om — syncToken i ett API-svar

Översättningsstatus — Godkänd lokaliserad etikett, belägg, ansvarig eller arbetsflöde, eller olöst status — Olöst; översättningen behöver granskas

Avsnitt 3

Hur avgör du stavning och skiftläge i den visade formen?

Börja med att identifiera vad termen syftar på: ett allmänt begrepp, ett varumärkes- eller produktnamn, en gränssnittsetikett eller en bokstavlig identifierare. Kontrollera produktdokumentationen eller ordlistan som är relevant för att hitta den officiella formen. Tillämpa sedan målpublikationens stilregler på vanlig löptext, rubriker och etiketter, och behåll dokumenterade undantag för namn och identifierare. Google avråder från onödig versalisering och varnar för att använda skiftläge som enda sätt att skilja betydelser åt; Microsoft säger på liknande sätt att gemener ska användas, utom i början av meningar och för egennamn, enligt deras metod med meningsversaler. Googles riktlinjer för versalisering Microsofts riktlinjer för versalisering

Jämför sedan formen med målorganisationens ordlista och ordbok där det är lämpligt. Anteckna källan och dess version eller kontrolldatum så att en annan redaktör kan följa hur valet gjordes. Dra inte slutsatsen att en form är officiell utifrån en tilltalande versalisering, ett sökresultat eller en översättning som liknar den engelska termen. Om källorna är oense eller inte anger formen ska du flagga raden för beslut i stället för att presentera en gissning som fastställd terminologi.

Avsnitt 4

Hur ska översättningar och gränssnittsetiketter kontrolleras?

Behandla översättning som ett beslut om betydelse och sammanhang, inte som en mekanisk omvandling av versaler och gemener. En etikett kan begränsas av gränssnittet, etablerad lokaliserad produktterminologi eller en annan grammatisk form i målspråket. Jämför förslaget med godkänt lokaliserat material och det sammanhang där läsarna kommer att möta det. Om det inte finns någon auktoritativ lokaliserad form ska du markera översättningen som olöst och be om ett beslut från rätt terminologiansvarig; hitta inte på en förment officiell motsvarighet.

När termbeslutet är fattat korrekturläser du den faktiska etiketten på sin plats. Kontrollera att versaliseringen följer det valda språkets regler och tillämplig produkt- eller husstil. Behåll den ursprungliga etiketten i termposten tillsammans med källan och statusen, så att en framtida redigering inte misstar en tillfällig översättning för en godkänd sådan. Om etiketten också nämns i instruktioner ska du kontrollera att löptexten använder samma formulering som på skärmen.

Avsnitt 5

Hur skyddar du kod- och API-identifierare?

Skilj bokstavliga strängar från redaktionell text innan du ändrar skiftläge. Jämför identifierare tecken för tecken med relevant API-referens, schema, kod eller gränssnitt. Bevara understreck, versaler och gemener, blanksteg och skiljetecken när de anges i källan; stilnormalisering hör hemma i den omgivande förklaringen, inte i ett bokstavligt värde. Googles guide tillåter uttryckligen former med enbart versaler eller camelCase i officiella namn eller vid hänvisningar till kod som använder dem. Googles riktlinjer för versalisering

Vid en praktisk granskning markerar du skyddade identifierare i termtabellen och kontrollerar sedan varje förekomst mot den. Om en mening i löptext använder en kodformad term som ett vanligt substantiv ska du avgöra om den kan förklaras med mer läsarvänliga ord, samtidigt som den bokstavliga identifieraren behålls i kodformatering. Om den auktoritativa definitionen i sig är oklar ska du dokumentera osäkerheten; en stilguide kan inte fastställa hur ett API fungerar eller vilket fältnamn som är kanoniskt.

Avsnitt 6

Vilken korrekturläsningsordning är tillförlitlig?

Den här ordningen är ett hjälpmedel för korrekturläsning, inte en automatisk översättning eller en universell versaliseringsregel. Nyttan ligger i att den gör varje redaktionellt beslut granskningsbart: vilken form som valdes, var den kommer ifrån, var den gäller och vad som fortfarande kräver ett beslut. För ett kort dokument kan en kompakt tabell räcka; för en stor terminologisamling behåller du samma fält i teamets etablerade arbetsflöde för ordlistor.

Samla in: Identifiera återkommande tekniska termer, produktnamn, etiketter, översatta termer och identifierare i materialet som granskas.

Verifiera: Konsultera tillämplig officiell dokumentation, ordlista, ordlista över föredragna former och stilguide. Anteckna källornas versioner eller datum när de finns tillgängliga.

Besluta: Fyll i tabellens godkända visningsform, tillåtna varianter och skyddade identifierare. Markera oenigheter och saknade översättningar som olösta.

Tillämpa: Redigera löptext och rubriker konsekvent, samtidigt som officiella namn, citerade formuleringar och bokstavliga identifierare bevaras.

Kontrollera igen: Sök i dokumentet efter varje registrerad variant och varje skyddad identifierare. Bekräfta att varje förekomst passar det angivna sammanhanget och lös eller eskalera sedan öppna poster innan terminologigenomgången markeras som klar.

Relaterad läsning

Fortsätt utforska detta ämne