RetroAchievements / RetroAchievements/docs

Create a translation dictionary guideline file for consistent localization

Open
#191 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
48
Forks
94
Avg merge
8h 9m
Merged PRs (30d)
13

Description

I noticed while doing some of the translations that we could benefit from having a standardized dictionary for terms that should or should not be translated across different languages.

I propose we create a new file to help maintainers and contributors with consistent translations.

Motivation
  • Some technical terms and names should remain in English (e.g. RetroAchievements, RA, DevJam, hardcore, leaderboard, ...)
  • Certain terms require specific translations to maintain consistency (e.g. Achievement -> "Conquista" in Portuguese)
  • This will help avoid confusion and maintain quality across translations
Proposed Solution

Create a new file translation-dictionary.md in the docs root with the following structure:

# Translation Dictionary Guidelines

## Portuguese (pt-BR)

### Do Not Translate
- RetroAchievements
- DevJam 
- DevQuest
- RANews
- Softcore
- Hardcore
- RAM
- ROM
- API
- ID

### Standard Translations
| English | Portuguese |
|---------|------------|
| Achievement | Conquista |
| Leaderboard | Tabela de Classificação |
| Badge | Emblema |
| Set | Conjunto |
| Points | Pontos |
| Developer | Desenvolvedor |
| Game | Jogo |
| System | Console |
Implementation Steps
  1. Create the initial dictionary file with Portuguese terms
  2. Review current translations to align with the new guidelines
Future Considerations
  • Expand to include spanish (ES) translations
  • Create automated checks for consistent term usage

@wescopeland Can I start working on it?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the docs root and create the proposed translation-dictionary.md using the Portuguese terms and structure described in the issue. Review the current translations for those terms, align them with the dictionary where appropriate, and confirm that the file documents do-not-translate names and standard translations clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.