Technical Writing Blog

Migrating to a new tool is a pain for anyone. Even when a new messenger is implemented in your company, there’s still this transition period. Yes, with sending messages being the primary function of an app, you still need time to get accustomed to the new UI. When you are a technical writer with many…

Technical writing requires tools for measurement and analysis like any other work process. Although, it is quite difficult to decide what metrics to use considering specifics of this field. We began discussing this topic a while ago and figured out the main aims of using metrics – you can either measure a documentation team’s productivity…

Punctuation in English is considered by many somewhat optional. But quotation marks are an exception here – you can’t skip them in such cases like a direct quote, for example. Quotation marks usage is often found confusing as British English and American English have different approaches towards this question. In this article, we will try…

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…

Creating user manuals is a difficult task on its own. Making them good is even more difficult. If while reading these first two sentences you thought to yourself, ‘Well, my technical documentation is quite good, actually’ – you might be missing an important point here: there is always room for improvement. Stagnation inevitably leads to…

User documentation is the face your company shows to the world. Having quality manuals is just as important as having a great support team. Remember, a lot of issues get deflected without actual involvement of support if documentation is okay. Plus, support teams work with users based on documentation for the most part anyway. It…

This post has been created in order to help technical writers find useful resources for professional growth. Here you will find resources for both experienced tech writers and those who have just started their professional journey. Top Online Technical Writing Courses Udemy At the moment, this huge learning portal offers 15 possible options for technical…

Technical writing and communication involves communicating complex information to specific audiences with clarity and accuracy. The key word here is communication, which is a term for two-way interactions. But in case of technical writing, the addressee side is shrouded in mystery. Technical writers often have a very vague idea of the end-users, their level of…

Almost any product has some kind of documentation to go with it. It might be just a warning or brief usage instructions. And, still, even then, there’s supposed to be a person allocated to write these two lines, and, more importantly, to decide what’s even supposed to be written. For more complex products, however, there…