S1.05.3Localization context metadatadesign

Strings need usage-context descriptions

Aliases: string context · translator note · developer comment

What it is

Localization context metadata is structured information traveling with a message through translation: who sees it, where and in what state it appears, what it refers to, which action and outcome it describes, and which variables or space constraints apply. It does not paraphrase the source; it supplies external information that changes target-language sense or grammar.

Why it happens

Translation resources are commonly presented as key lists detached from screens, so linguists cannot see control role, preceding state, or variable source. Short copy is highly underdetermined: “Save” may be a button verb or a noun, and {name} may denote a person, file, or place that triggers different case or agreement. Persistent context fields make those conditions reviewable. An explanation given once in chat does not remain attached across keys, versions, and vendors.

Where it stops holding

Context notes cannot rescue unclear source copy or eliminate the need to inspect the UI. “Home-page text” and “translate correctly” add no actionable evidence, while pasting a full requirements document hides the decisive facts. Metadata can become stale after component reuse or flow changes, so it must evolve with the message key and use sites. Real examples containing user data require redaction.

Applying it

  • Record control type, page/state, speaker and audience, part of speech, referent, action consequence, tone, variable semantics, and space constraints.
  • Give every placeholder a type and example, stating whether it is a person, quantity, date, or gendered lexical item rather than merely “variable.”
  • Keep developer comments, translation-platform descriptions, and code use sites traceably linked; trigger context review when a caller changes.
  • Sample a resource package without extra product knowledge and ask linguists to explain each message's use; return ambiguous keys for clarification, then perform linguistic QA in the real UI.

Related

  • Same group: S1.05.1 The same source word needs different translations in different placements · S1.05.2 Reusing strings freezes the translation's grammatical form · S1.05.4 Interface screenshots provide the most effective context
  • Adjacent: S1.06 Word-order problems in concatenated strings · S4.04 Continuous localization integration
  • Search terms: localization context metadata · developer comment · placeholder annotation

Cards in the same group

Quick Actions

Share

Share this page

ios_share

https://hci.top/en/handbook/S1.05.3