This rule enforces consistent spelling across documents, particularly focusing on British versus American English variations. It's important because inconsistent spelling across a document or documentation set can appear unprofessional and confuse readers, especially in technical or formal writing contexts.
The rule is particularly valuable for organizations that need to maintain a consistent voice and style across their documentation, ensuring that either British or American English spellings are used consistently, but not mixed.
Examples:
- Flags when "colour" and "color" are used in the same document set
- Checks for variations like:
- advisor/adviser
- centre/center
- finalise/finalize
- learnt/learned
- organise/organize
- recognise/recognize
- Will raise an error if inconsistent spellings are found, regardless of case (ignorecase: true)
The rule will flag any inconsistent usage with the message "Inconsistent spelling of '[word]'", allowing writers to maintain consistency in their chosen spelling standard.