Technical Writing Blog

Envision a user eagerly clicking on a link to access a technical guide for a new software tool they are learning. As the page loads, instead of a skeleton screen that outlines where text and images will soon appear, they are met with a blank canvas or a spinning wheel. This absence can leave the…

Engaging with your audience is more than just sharing information; it’s about fostering conversation and building a community. In the digital age, comments and feedback serve as the lifeblood of user interaction, transforming monologues into dialogues and single narratives into rich, multi-perspective discussions. In this blog post, we’ll delve into the art of encouraging user…

In the course of creating technical content, many writers encounter the challenge of determining how sophisticated or simple their language should be. Though it might seem like an odd question, it is a genuine dilemma. If you choose overly complex language or jargon, the technical documents you create can be difficult for the reader to…

Fonts are an important part of any documentation design be that API documentation, user manuals, case deflection or something else. That is basically the body of the written text. Choosing a font directly influences text perception by readers: its readability and accessibility. Which, in its term, can change the learning curve and product adoption. In…

UX as a term is used more often when talking about user interfaces, but it can be applied to any object a human can interact with. Being an important part of the user journey, technical documentation deserves a special mention in terms of UX. Today, we will give you several tips to make your user…

If you are concerned about your user manuals looking bad, this article will give you certain focus points improving which can turn the situation around. How far you want to take it depends on your subjective opinion regarding this matter. Some people believe that when technical documents look neat, and there are no design elements…

The role of a UX writer emerged not so long ago on the job market, but it has been growing ever since. Major companies like Google are heavily focused on everything UX-related and UX writing as well. UX writing looks like some derivative from technical writing, however, it pursues a different goal. While an average…

Remember, when you studied in college you had to deal with writing different papers? And, if they were not hand written there were all those requirements about the font size, the quotes, the page breaks…’Yuck! But my paper is very much readable the way it is. Do I really have to do this? What a…

The numbers paint an accurate picture: visual content rules the digital world. Articles that feature relevant images get about 94% more views than content without graphics. Moreover, the human brain is wired to respond better to visual stimuli than text. In fact, we process images 60,000 times faster than the written word. That’s undoubtedly huge….

Let’s be honest. Speed is everything these days. If a website (or, an online documentation portal takes just one second too long to load, it can negatively affect your business. And, with the mobile Internet on the rise, online users just aren’t willing to wait for anything. In fact, 47% of people expect a page…