Technical Writing Blog

Today, documentation is one of your company’s assets. It helps your customers understand how your product works or, putting it differently, enhances the usability of your product. This is why documentation should often combine seemingly opposite features. It should be both comprehensive and concise, visually appealing yet informative, neutral but also stylish (or even extravagant…

Source: LinkedIn. For 70 years, the Society for Technical Communication (STC) has been at the forefront of advancing the theory and practice of technical communication. In this article, we’ll take a closer look at the history and mission of the STC and explore how it has contributed to the success of its members and the…

Our latest Blossom update will take your content creation to the next level with Markdown import, better PDF export, Confluence import updates, and more. We have made the initial steps towards a complete transformation of the Contributor’s app that are sure to ease your work inside the portal. Furthermore, we have implemented a bunch of…

At least once in their career, most employees, both new hires and experienced ones, have faced a situation when they lack information concerning their working routine, business relations, or legal counsel (information about their rights and responsibilities). Each time this happens, employees find themselves in an information vacuum which is a fertile ground for the…

In today’s digital age, product documentation has become an essential component of a successful business. However, it’s not just about having clear and concise documentation for your customers. It’s also about creating a seamless experience for them when accessing this information. That’s where branding comes into play. In this article, we will explore the importance…

‘Reading and comprehension skills’ is a term usually associated with schooling. We often hear these words pronounced by a school teacher and applied to students. We are used to thinking these skills are relevant only at the beginner stages of education. However, ‘reading and comprehension’ is a skill we use daily, actually, every time we…

Any technical writer knows that the document creation process can be full of challenges. From using the right terminology to using the appropriate tools, there are a lot of things that can trip you up. For example, technical writing in the pharmaceutical industry is a highly specialized field with very little “creative license” with documents….

The selling process is often regarded as art, as sales depend greatly on the talent some salespeople have (and some don’t). You may call it charisma, charm, magnetism, or personal attractiveness. Whatever it is, there is something irrational in the sales process that cannot be explained. This is partly because selling is primarily based on…

Your ‘ideal product concept’ may be ‘not so ideal’ after the product launch. This is often the case when you get negative feedback from customers. The features they get turn out to be not the best solutions for their problems. They may solve them but partly or, in the worst case, be useless. This situation…

If you are an API technical writer, chances are you have heard of Swagger. In this blog, we will explain the main tools that Swagger offers, the advantages of this powerful platform, and ways to connect your API documentation created in Swagger with your user manuals. What Is Swagger? Swagger is a set of open-source…