User manuals, online help and user interface text (and translations to alternative languages) are best created by writers trained in technical writing.
Technical writing differs significantly from normal writing by adhering to the following writing principles:
- Use short sentences
Long and convoluted sentences slow down reading.
- Use familiar words
Use terms your users are familiar with. They may not always be the strictly correct terms, but attempting to educate users in manuals slows down reading.
- Avoid synonyms
Always use the same terms even if you feel it gets repetitive – it’s supposed to. Varying your language with synonyms slows down reading and risks confusing your reader.
- Avoid bloat
Avoid introductions, build-ups, anekdotes and summaries. They slow down reading.
Technical writing is quick to read, takes up minimal space, and is easy to translate to other languages.