T1.05.3Internal identifier leak preventiondesignresearch

Internal codenames must never reach the user interface

Aliases: codename leakage · engineering name exposure · user-message mapping · public reference ID

What it is

Internal identifier leak prevention stops project codenames, service names, experiment labels, database fields, internal error keys, and ticket categories from crossing the content supply chain into user interfaces. It maps them to objects, states, and actions users recognize. This does not mean erasing every diagnostic identifier: a public, non-sensitive reference ID that support can look up may connect a specific incident to a support record, but it must not replace an understandable account of the problem.

Why it happens

Internal names usually optimize engineering uniqueness, deployment, monitoring, or experiment coordination and make no product-language promise. Leaks occur at supply-chain seams: raw backend exceptions pass through, templates interpolate internal fields, missing translations fall back to keys, experiment branches use temporary labels, and log or status-system text gets copied into notices. Users cannot connect these tokens to the task they were performing. Exposure may also reveal architecture, vendors, unreleased features, or security rules. A user-message mapping layer turns internal reason codes into stable public messages and safe actions while a public reference ID preserves the support link.

Studying it

Map data flows from services, content management, experimentation, and localization into UI, email, status pages, and support tools. Capture final rendering for success, error, timeout, unknown, and degraded branches. Scan with the internal-name inventory, key-pattern rules, and sensitive terms, then have content, security, and support reviewers distinguish a leak from legitimate public terminology and an approved reference ID. Incident exercises should show both that users can explain what happened and what to do, and that support can locate the event from the reference ID. Absence of user complaints is not evidence of absence.

Where it stops holding

Developer-facing APIs, CLIs, and privileged diagnostic interfaces may require machine identifiers, but scope follows actual audience and authorization, and an actionable explanation can still accompany them. A public reference ID should be an indirect identifier that is unpredictable or at least reveals no account, resource, policy, stack, or other sensitive semantics; it also needs suitable retention and access controls. User-generated content, audit originals, and codenames typed by users must not be silently rewritten and should be separated from product-generated leaks. Security messaging may withhold exploitable rule details without collapsing into a bare code.

Applying it

  • Map internal reason codes to public messages containing the user object, resulting state, safely disclosable reason, next step, recovery path, message owner, and version. Route unknown codes to a reviewed fallback, never the raw exception.
  • Add leak detection to UI strings, error responses, notification templates, status notices, experiment variants, and localization fallbacks. Put internal-name inventories and key patterns in CI and sample unknown runtime branches for alerts.
  • Design the public reference ID separately: label it as a reference, make it copyable and support-searchable, and never expose database primary keys, trace tokens, stacks, policy reasons, or internal service names directly.
  • Before release, run a fault-and-degradation scenario matrix. Verify that every user touchpoint has an understandable, recoverable message and only the minimum diagnostic linkage. Fix the mapping or supply-chain entry when a leak is found instead of patching one rendered string.

Related

  • Same group: T1.05.1 Use abbreviations only when the target audience already knows them · T1.05.2 Expand on first use or offer an explanation affordance
  • Adjacent: T2.04.3 Do not expose internal technical detail · T3.04.2 Multi-channel content needs a single source of truth
  • Search terms: codename leakage · error mapping · public reference ID

Cards in the same group

Quick Actions

Share

Share this page

ios_share

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