3 definitions in this file:
The recommended label text (e.g., 'Add', 'Cancel', 'Delete', 'Save as', 'Learn more'). This is the canonical form as it should appear in the UI.
What this label means — the action it represents. Should be concrete and unambiguous (e.g., 'Destroys an existing object so that it no longer exists' for Delete).
When and how to use this label. Include context, formatting rules, and any qualifications (e.g., 'Where appropriate, combine Add with the object: Add user, Add role').
Related terms that serve a different purpose but are often confused with this one. Listed for comparison — helps authors choose the right label. The terms SHOULD match other `term` values in the same content guideline for cross-referencing.
Where this label is used in the UI (e.g., 'Buttons in dialogs', 'Navigation links', 'Form submission', 'Toolbar actions'). Helps authors understand the typical placement and scope.
Visual or code examples showing the label in context — do/don't pairs, screenshots of correct usage, or code snippets.
References:
richText, example
The localization concern being addressed. Standard values: 'rtl' (right-to-left layout mirroring and bidirectional text), 'text-expansion' (content lengthening during translation), 'pluralization' (plural forms varying across languages), 'date-format' (date and time formatting conventions), 'number-format' (decimal separators, grouping), 'currency' (currency symbol placement and formatting), 'text-direction' (mixed-direction content within a single string), 'icon-direction' (icons that imply directionality), 'truncation' (text overflow behavior across languages), 'sorting' (locale-specific sort order and collation), 'concatenation' (avoiding string concatenation that breaks in other languages). Custom values are permitted and SHOULD be lowercase kebab-case.
Guidance for addressing this localization concern. Should be actionable and specific — describe what changes across locales, what the author or developer must do, and what to avoid.
Visual or code examples illustrating the localization concern — before/after screenshots for RTL, examples of text expansion, or code patterns for pluralization.
References:
richText, example
Identifies this guideline as a content spec.
Recommended action labels and terminology. Each entry defines a standard label with its meaning, usage guidance, and cross-references to related terms. Ordering is significant — tools SHOULD preserve it for display. Authors MAY order alphabetically or by frequency of use.
Min items: 1
Localization and internationalization considerations. Each entry documents a concern that affects content across languages and writing systems — RTL mirroring, text expansion during translation, pluralization rules, and other i18n concerns. Ordering is significant — tools SHOULD display considerations in this order. Authors SHOULD order by impact or frequency.
Min items: 1
Overview of the content guidelines — content philosophy, voice and tone principles, or the scope of labels and localization rules covered.
Agent-optimized context for this document block. Provides structured information for AI/LLM consumption — constraints, disambiguation, anti-patterns, examples, and keywords.
Constraint: At least one of labels, localization must be present.
References:
richText, contentLabelEntry, localizationEntry, agents
Design System Documentation Standard (DSDS) 0.1 — Draft Specification
GitHub