i18n-dict-text

Enforce user-focused naming and grouping for i18n dictionary keys.

Updated Aug 25, 2024
One-click install
npx skills add https://github.com/Kaspazza/doom-config --skill i18n-dict-text
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: i18n-dict-text
Source: https://github.com/Kaspazza/doom-config/tree/main/eca/skills/i18n-dict-text
Command: npx skills add https://github.com/Kaspazza/doom-config --skill i18n-dict-text

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

i18n dictionary keys often reflect implementation details rather than user-visible meaning, leading to translation ambiguity and maintenance pain.

Core Features & Use Cases

  • Action-oriented naming that describes user-facing outcomes
  • Consistent grouping and prefixes for related keys
  • Clear examples of well- and poorly-named keys

Quick Start

Rename your dictionary keys to describe user value, using the rules described above.

Frequently Asked Questions about i18n-dict-text

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I name i18n dictionary keys for better translation consistency?

To improve translation consistency, name i18n dictionary keys by user-facing value so they describe visible outcomes rather than implementation details. This action-oriented approach reduces ambiguity and maintenance pain across languages.

Why do my i18n translation keys cause ambiguity for translators?

i18n keys cause ambiguity when they reflect implementation details instead of user-visible meaning. Naming keys based on user-facing values ensures translators understand the context, reducing translation errors and maintenance pain.

What is the best way to structure i18n dictionary keys across multiple languages?

The best way to structure i18n dictionary keys is to group them consistently using prefixes and action-oriented names that describe user-facing outcomes across all languages. This keeps translations aligned and maintainable.

Can I use user-focused naming guidelines for i18n keys in domain dictionaries?

Yes, you can apply user-focused naming guidelines to i18n keys in domain dictionaries like domain/i18n/dict/text.cljc. This enforces consistent grouping and ensures keys describe user-facing values clearly.

How do I rename existing i18n dictionary keys to describe user value?

Rename your existing i18n dictionary keys to describe user value by applying action-oriented naming and consistent grouping rules. This ensures keys reflect user-facing outcomes rather than internal implementation logic.