Reducing the complexity of technical language (new article in Simplifying Complexity series)
Here’s a summary:
Highly technical material often becomes incomprehensible due to the unfamiliar terminology that’s simply part of the technical domain. Readers who don’t already speak the technical language in fluent ways will struggle to make sense of the material. To make these highly technical texts more accessible to users of all levels, you can create glossaries, embed definitions in tooltips, provide links for background knowledge, and more. As you define your terms, it’s helpful to read beyond your company’s content and check out how the same terms are used in your competitor’s documentation and industry articles. As you become more aware of terms and their definitions, you will be more precise and careful with language in your documentation.
Continue reading: Reducing the complexity of technical language
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.