Technical documentation may be consumed by a global audience, making it important to be mindful of language variants, such as British and American English. WriteTech Hub primarily uses British English in its documentation, but understanding the differences between the variants can help ensure clarity and consistency.
Choosing Between American and British English:
- Default to British English: WriteTech Hub uses British English as the standard. Example: “colour” instead of “color,” “organisation” instead of “organization.”
- Use British English spelling, grammar, and punctuation: Follow British conventions consistently throughout all documentation. Example: “centre” instead of “center,” “analyse” instead of “analyze.”
Consistency in Language Use:
- Avoid mixing language variants: Consistency is key. Do not mix British and American English within the same document. Example: Do not use “organise” and “organize” interchangeably.
- Respect regional differences where necessary: If a specific region is being addressed (e.g., in localised content), consider using the appropriate language variant for that region.
Considerations for Translation and Localisation:
- Be mindful of terms that differ significantly: Some terms have different meanings in British and American English. Example: “Rubber” in British English refers to an eraser, while in American English, it often refers to a condom. Ensure that terms are appropriate for the intended audience.
- Prepare content for easy localisation: Write in a way that makes translation easier by avoiding idiomatic expressions or culturally specific references that may not translate well.
Dos:
- Use British English spelling consistently: Example: “The programme was launched last year.”
- Be aware of regional differences in terminology: Example: “Postcode” (British) versus “ZIP code” (American).
Don’ts:
- Don’t mix British and American English: Example: Avoid using “colour” (British) and “favorite” (American) in the same document.