Technical Writing Blog

You can create a truly awesome user manual. Hundreds of topics that describe every product feature thoroughly. Navigation elements that are conveniently located throughout the documentation. Your readability score is high. You’ve configured styles and scripts in your online documentation portal according to your needs. It’s been going great, except… How are you going to…

One of various things technical writers can do is compose questionnaires and write interview questions. Users are the perfect candidates for being interviewed! Goals of these interviews can vary, we will talk about that in a moment. For now, we would like to point out that users can be your best advocates and they have…

Our previous post was addressed to problems with technical documentation. So, we set up a poll on our Telegram Channel. According to it, technical writers’ biggest concern is that people don’t read documentation. Imagine how frustrating this is – all the work you put in just to learn it was pointless. This sounds demotivating. Let’s…

There are certain issues that are very common for technical documentation teams all over the world. We will not only name them in this blog post but will also provide comprehensive solutions. Let’s begin. You Don’t Have a User Manual Or, rather, you wouldn’t call what you have a user manual. This is easily the…

Technical documentation is very complicated as it is. Don’t let your readers get lost in it! Give them a helping hand – navigation. Ideally, readers don’t need to be conscious of navigation elements they use. Moving between help topics should feel intuitive and seamless. This can be achieved if you have the right toolset at…

Why do we recommend using visual elements in technical documentation? Well, the answer is simple – the human brain is very good at distinguishing colors and understanding patterns. So, when you add maps, graphs, charts, infographics, dashboards, etc. to text, you are doing a big favor to readers and yourself. Using visualization techniques as a…

Sometimes, we get so used to looking at things from a certain perspective that it is getting increasingly harder to see how it may look for others. For instance, no matter how important it is for technical writers to think like readers to deliver better user manuals, it can be a tough call. Let’s shift…

SoftwareSuggest is a platform that helps users discover top business software and service partners to improve their business. They list, review, compare and offer free service solutions and consultation of business software so that you’re guaranteed to find the best match for your business. Every year SoftwareSuggest arranges awards. It is a stamp of approval…

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…

Marketing is viewed as a separate field in business. Marketing teams are responsible for attracting potential clients and taking action to persuade them that the product holds the solution they were looking for. However, a lot of factors influence this process, and often they are out of the marketing team’s scope. Let’s take a technical…