The importance of terminology in technical writing
Applying correct terminology plays a crucial role in various types of writing. In this article, you will discover why terminology is so important, particularly in the realm of technical writing.
The key takeaways are:
- Use the same term when referring to the same type of reader
- Use the same terminology for the same case (scenario)
- Use the simplest word possible
Use the same term when referring to the same type of reader
- You When you are referring to a reader who is also a person using the product.
- User When a reader is not a person who is using the product.
- Authorized User When you need to differentiate between users with or without specific permissions.
- Technician, System Administrator, etc. When you need to emphasize that a person has a specific technical role.
Use the same terminology for the same case (scenario)
When you use consistent terminology for the same scenario, it eliminates confusion and ambiguity. As a result, your audience will better comprehend complex technical information.
- Maintain a uniform terminology throughout the whole document
- Avoid confusing layout
- Focus on keeping your text consistent and in a logical order
- Don’t mix similar callouts such as “Warning”, “Important”, “Remember”, or “Note” (readers will not understand the difference between them)
- Consider using steps or numbered bullets for more clarity
Use the simplest word possible
The aim of technical writing is to deliver a message that will be understood by readers. We don’t want to confuse our readers. Please bear in mind that not everybody is a native English speaker.
Use:
- “Show” over “Demonstrate”
- “Help” over “Facilitate”
- “Start” over “Initiate”
- “Change” over “Modify”
- “Stop” over “Terminate”
Maintaining consistent terminology throughout technical documents is extremely important for effective communication with readers. Take advantage of the examples presented above and start improving your technical writing proficiency today.
Find out more about technical writing tips: