Back
to top

    Technical Writing Blog

    Grow your technical writing expertise with industry news, best practices, articles, product updates

    How to Develop an Employee Handbook

    How to Develop an Employee Handbook

    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…

    Continue reading »
    Posted in Technical Writing on 4/19/2023

    Documentation Portal Design: Why Is It Important and How to Create Stunning One

    Documentation Portal Design: Why Is It Important and How to Create Stunning One

    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…

    Continue reading »
    Posted in ClickHelp Features on 4/12/2023

    Improve Readability With Flesch-Kincaid Grade Level

    Improve Readability With Flesch-Kincaid Grade Level

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

    Continue reading »
    Posted in Technical Writing on 4/5/2023

    Structured Authoring Environments and Pharma Industry

    Structured Authoring Environments and Pharma Industry

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

    Continue reading »
    Posted in Technical Writing on 3/30/2023

    How to Create Sales Documentation

    How to Create Sales Documentation

    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…

    Continue reading »
    Posted in Technical Writing on 3/22/2023

    What Is a Market Requirements Document?

    What Is a Market Requirements Document?

    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…

    Continue reading »
    Posted in Technical Writing on 3/15/2023

    Swagger for Technical Writers: Benefits and One Big Limitation

    Swagger for Technical Writers: Benefits and One Big Limitation

    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…

    Continue reading »
    Posted in ClickHelp Features on 3/9/2023

    ClickHelp Steals the Show at MEGAComm 2023: Git, OpenAPI, Confluence

    ClickHelp Steals the Show at MEGAComm 2023: Git, OpenAPI, Confluence

    The annual MEGAComm conference – one of the most significant gatherings of communication professionals, was held from February 22-23, 2023. And it was a blast! So many captivating presenters, and ClickHelp was one of them. The company’s team of experts was on hand to provide demos, answer questions, and share insights into how businesses can…

    Continue reading »
    Posted in ClickHelp News on 3/1/2023

    Who Is a Product Manager?

    Who Is a Product Manager?

    Building software can be regarded as a cooperation process involving many stakeholders inside and outside the company. The cooperation can be either a success or failure depending on how people define and share the responsibilities. The old-fashioned way of work is when the team is split into two opposite ‘forces’, one issuing requirements and the…

    Continue reading »
    Posted in TechComm Career Path on 2/22/2023

    ChatGPT for Technical Writing Purposes

    ChatGPT for Technical Writing Purposes

    The tech industry is constantly evolving, so it’s important to stay up-to-date with the latest developments and be adaptable and open-minded to new technologies and trends. Today we’re reflecting on ChatGPT by OpenAI. This revolutionary technology is all over the news, so we couldn’t walk on by it and decided to look at it in…

    Continue reading »
    Posted in Technology on 2/15/2023