Back
to top

    Technical Writing Blog

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

    Quick Start Guide: What Is It and How to Write a QSG?

    Quick Start Guide: What Is It and How to Write a QSG?

    Practice shows that no matter what the product is, its users generally fall into two categories: those who want to get a profound knowledge of the product before using it and those who wish first to start using the product and then learn all the details. People from the first category prefer to carefully read…

    Continue reading »
    Posted in Technical Writing on 3/23/2022

    Content Strategist Job Description: Responsibilities, Skills, Career Path

    Content Strategist Job Description: Responsibilities, Skills, Career Path

    A significant increase in customers’ demands, business activities, and permanent cooperation between different spheres of social life leads to a necessity of providing more and more content of any kind: from educational to entertaining and promotional. Companies worldwide deal with the challenge of producing and updating relevant content for different types of audiences to successfully…

    Continue reading »
    Posted in Technical Communication on 3/16/2022

    Good and Bad Technical Documentation Examples

    Good and Bad Technical Documentation Examples

    Are your user manuals good or bad? Let’s run them through our quick checklist. Don’t get discouraged if it turns out to be not perfect, this article contains a lot of ideas to follow that can change your software documentation for the better! Data Completeness and Accuracy Bad user manuals make customers feel frustrated and…

    Continue reading »
    Posted in Technical Writing on 3/11/2022

    Popular Documentation Myths Busted with ClickHelp

    Popular Documentation Myths Busted with ClickHelp

    Conferences for technical communicators are essential to increasing your expertise in the field, learning something new, and networking. That is true for the MEGAComm 2022 conference that took place at the beginning of February. It was a global event for tech comm-related experts who wanted to be in the loop with the latest in the…

    Continue reading »
    Posted in ClickHelp News on 3/10/2022

    SDK Documentation: What Is It and What Is the Difference Between SDK and API?

    SDK Documentation: What Is It and What Is the Difference Between SDK and API?

    The present-day virtual reality is a dynamic world whose borders are expanding daily. Its basic features are growth and integration. Growth means more and more software, websites, platforms, and resources. These elements are not isolated. They are involved in the process of constant integration. Integration implies the existence of features that are identical or, at…

    Continue reading »
    Posted in Technical Writing on 3/9/2022

    Content Modeling for Technical Writing: Definition, Importance, Creating

    Content Modeling for Technical Writing: Definition, Importance, Creating

    Have you ever faced a situation when you cannot find the text you need and, what’s more important, the text you have authored yourself? Or, when you cannot localize a news story, you posted some time ago on your website? This often happens when you have to work with large amounts of text like company…

    Continue reading »
    Posted in Technical Communication on 3/2/2022

    11 Skills of a Good Technical Writer

    11 Skills of a Good Technical Writer

    The definition of a technical writer is the following: a technical writer is an expert that deals with technical communication and transforms complex information into clear and concise technical documentation. A technical writer creates the following types of technical documentation: user manual, user guide, release notes, API documentation, reports, reviews, web pages, specifications, etc. What…

    Continue reading »
    Posted in Self-Development on 2/28/2022

    Troubleshooting Guide: Definition, Importance, and Tips for Creating

    Troubleshooting Guide: Definition, Importance, and Tips for Creating

    Every business dreams of smooth running every day without interruptions. So that everything worked exactly as it should and there would be no stoppages to the day-to-day functions. But, there comes a time when something will go wrong at some point. And sometimes this requires the employees to solve problems. Most commonly, this is a…

    Continue reading »
    Posted in Technical Writing on 2/24/2022

    Release Notes: Definition, Examples, How to Create Release Notes?

    Release Notes: Definition, Examples, How to Create Release Notes?

    When we think of release notes, we roll our eyes, remembering a dull side note met without enthusiasm by users. They’re a legal obligation that must be done, but they’re done without too much effort. A little while ago, people used to buy products and software, and there was no evident feedback bridge between developers…

    Continue reading »
    Posted in Technical Writing on 2/16/2022

    ClickHelp Partnership With Tech-Tav

    ClickHelp Partnership With Tech-Tav

    We are delighted to announce a new partnership between ClickHelp AM LLC and Tech-Tav Documentation, Ltd. Tech-Tav becomes an authorized reseller and service partner in Israel. A new collaboration will help lead the industry towards newer and better ways for technical writers to deliver content to customers in an engaging and worthwhile user experience. Both…

    Continue reading »
    Posted in ClickHelp News on 2/9/2022