Technical Writing Blog

If you’ve ever read documentation written by a programmer, it will become clear pretty fast that creating user guides requires a whole different set of skills. Sure, programmers might have the necessary knowledge base, but most of them aren’t very apt in communicating the information in a user-friendly manner. Thus, the user guides they create…

Your documentation team is one busy department. Useful documentation heavily relies on your team’s ability to keep the workflow moving, but in a business where things are notoriously fast-paced, that can be a difficult thing to achieve. With that said, you might find another article interesting, that is – Documentation Team: How to Delegate Tasks….

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….

You may have seen this job title popping on professional platforms or in your network, only to ask yourself: what exactly does a technical writer do? The intuitive definition of technical writing is that it is a profession that focuses on documenting the knowledge base of products and services and making them easy to understand…

It is hard to imagine now that people will be ever going back to living thier lives without the Internet. Being offline will soon disappear as a concept. The IOT is about to burst, and this will finally settle ‘being online’ as equal to ‘being alive’. Our newspapers, TV shows, family pictures, work…Everything is just…

Becoming part of a documentation team can be a challenge for a writer who is not experienced in this type of work, as it requires a new set of skills and a very specific writing style and approach. Even if you recruit a writer with prior experience in creating documentation and user guides, you still…

Technical documentation is not just any text. It is a whole new world with its rules and patterns to follow. This article will explain how technical writers can avoid the most common mistakes when writing a user manual. Abbreviations Abbreviations are great. They save us time and effort. We can transmit information faster using abbreviations,…

What do we want from any user manual? Clarity and consistency. And, good looks. How can we achieve this? Well, as far as looks are concerned, you can start off by reading this article on user documentation design. And, there’s a long list of things that can be done to improve a user manual’s consistency…

If you are a native English speaker then the choice between Active Voice and Passive Voice is likely to be obvious to you. But, if you are writing user guides in English or working in an English speaking team while it is not your mother tongue – you should study the vital difference between these…

Any technical writer should know their grammar. Actually, they should know a lot of other things and possess many other skills. But grammar comes first. In case you are wondering about the ‘other things’ a tech writer should be able to do, take a look at this article on 11 skills of a good technical…