Technical Writing Blog

Trying to predict what’s coming is only natural for humans. This can prove useful for planning, especially in business when you always have to be prepared for what the future holds. On the other hand, it is just fun to do so. Technical writing is integrated into many professional spheres, and it is being heavily…

We strongly believe that technical documentation should be available for everyone regardless of their health condition. That is why we have decided to create a series on technical documentation inclusivity. This article will explain the challenges colorblind people face when reading user manuals and ways to improve technical documentation to make it more accessible to…

Halloween is finally here. What do we love about this holiday? The smell of fallen leaves, pumpkin lattes, spooky decorations, and scary stories, of course. For all the years technical writing has been around, it has accumulated a lot of stories that are worth mentioning on Halloween. The things that scare the HATs out of…

There are many things that can improve your technical writing experience. One of them is navigation. Especially, when an online documentation portal is quite big, it is important to have a convenient tool to navigate through it. So, every help authoring tool is trying to provide a solution in this regard. Let’s see how the…

Nowadays, technical writing is a marketing tool. Online documentation contains keywords, it can be cross-linked with a corporate website, it gets branded. Your online documentation portal is indexed by all major search engines, and it shows up in search results for your clients. And, so, the term ‘target audience’ is quite common in technical writing,…

What industries employ technical writers? It is really hard not to answer ‘all of them’. Yes, this profession is quite popular now, and many spheres require tech writing specialists. When you know where exactly you can find employment, you have the opportunity of weighing out your options and choosing what’s best for you personally. This…

An API without a good user manual is next to useless. Developers would like a clear view of an API, code examples, detailed explanation of calls and parameters. And, they are not the only people visiting an API documentation portal. Many people with different roles are involved in API nowadays as this sphere has gained…

What is a perfect help topic? It is a topic that delivers a solution to its readers in the most efficient manner. Creating such topics means paying attention to their every element and analyzing them. Further, you will find practical advice on improving each help topic element to create great technical documentation. Title It all…

Metrics are the easiest way for managers to analyze work processes, make conclusions and see whether everything is going according to plan. If it is not, some changes need to take place. Metrics also help controlling employee performance and efficiency of the current processes. Technical writing requires metrics just like any part of product development….

We have written a lot of articles in this blog about self-development for technical writing specialists, given tips on writing user manuals, shared best practices of applying for a job as a technical writer. But one of the main topics of interest is yet to be covered – salaries in technical writing. Salary rates change…