Styleguides

styleguide.md

Applies to every locale and contains overall guidance.

Put here:

• Who your users are
• The voice and tone to use
• Terminology your product uses
• Names to keep as-is across translations

# Styleguide

## Audience

A few sentences about who your users are and how your site/app serves them.

## Voice and tone

- Friendly and concise.
- Address the user as "you", and prefer active voice.

## Terminology

- "workspace": The place where a team keeps its projects

## Do not translate

- eloqnt
- API key

Styleguides are self-contained. eloqnt/engine doesn't follow local or external links inside them, so any guidance the engine needs must live in the file itself.

styleguide.<target-locale>.md

Used by eloqnt translate when translating into that locale. This file layers on top of the global styleguide and takes precedence wherever the two conflict.

Put here:

• Tone specific to the language, like formal or informal address
• Formatting conventions, like quotation marks or which plural cases to include
• How to translate particular terms

# `es` styleguide

## Tone

- Use informal "tú", never formal "usted".

## Formatting

- Use straight quotation marks (`"…"`), not Spanish guillemets.
- Always include the `many` case in `plural` statements. It covers millions, which need "de" before the noun ("1.000.000 de archivos").

## Glossary

- "dashboard": "panel"

styleguide.<source-locale>.md

Used by eloqnt review when checking your source strings. This file layers on top of the global styleguide and takes precedence wherever the two conflict. Rules stated here are enforced as fixes, so stick to mechanical ones.

Put here:

• Typography, like ellipses and dashes
• Capitalization rules

# `en` styleguide

## Typography

- Use the … character for ellipses, never three dots.
- Em dashes have no surrounding spaces (word—word, never word — word).

## Capitalization

- Menu items, button labels, and alert titles use Title Case.
- All other UI text uses sentence case.