Back
to top

    Technical Writing Blog

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

    Using ClickHelp for API Documentation

    Using ClickHelp for API Documentation

    The API industry keeps growing, and many companies require software for technical writing that would allow creating more comprehensive API technical documentation. No doubt, you can create API documentation even in plain text, but would it be readable? Modern techcomm specialists are striving for more efficient and user-friendly docs, so, certain requirements exist that a…

    Continue reading »
    Posted in ClickHelp Features on 6/25/2019

    Technical Documentation Branding – What for?

    Technical Documentation Branding – What for?

    Documentation branding – a lot of people are doing it, but few know why it is such a necessity. In this post, we will touch upon the main goals of documentation branding and also equip you with the right tool to style your docs in an efficient manner. Why Branding Your Technical Documentation is Good…

    Continue reading »
    Posted in ClickHelp Features on 5/24/2019

    Web Help: Pros and Cons

    Web Help: Pros and Cons

    Online documentation was a very logical next step for technical writing. The Internet has become so easily accessible that looking up something online seems like a natural part of our lives. So, storing documentation online is not only a matter of convenience; by now, it has become common sense. Help authoring tools like ClickHelp allow…

    Continue reading »
    Posted in ClickHelp Features on 5/17/2019

    Unique Selling Points of ClickHelp

    Unique Selling Points of ClickHelp

    We have been developing our help authoring tool, ClickHelp, for quite some time now. It has been a long journey of learning to prioritize things, to listen to feedback and apply it. Different workflows require different functionality, so we have been learning how to balance out our technical writing tool and make it more flexible….

    Continue reading »
    Posted in ClickHelp Features on 5/14/2019

    ClickHelp Features: Context Help

    ClickHelp Features: Context Help

    Documentation delivery is quite an important process and can be provided in different formats. You can send out PDF files, send printed documentation or host your documentation online. Having online documentation is very useful, as you can instantly share any topic with a user and they can open it right in their web browser. But…

    Continue reading »
    Posted in ClickHelp Features on 4/9/2019

    ClickHelp Aurora Polaris Features (part 1)

    ClickHelp Aurora Polaris Features (part 1)

    ClickHelp Aurora Polaris has been released recently. While you are already enjoying all the improvements and new functionality, we will keep describing the awesome changes and enhancements the new tool version brings. We would like you to get maximum benefit out of this release! This product update is a huge event for ClickHelp, some changes…

    Continue reading »
    Posted in ClickHelp Features on 3/29/2019

    ClickHelp March Release Sneak Peek – Agile Technical Writing

    ClickHelp March Release Sneak Peek – Agile Technical Writing

    We are about to provide you with another exclusive insight into the next ClickHelp product release! Today, we will share details of an exciting feature that will become available this March. ClickHelp users are getting the possibility of updating/adding any amount of help topics to their docs instead of preparing the whole project for an…

    Continue reading »
    Posted in ClickHelp Features on 3/4/2019

    Sneak Peeks – Navigation, Taxonomies, mini-TOC, FTS

    Sneak Peeks – Navigation, Taxonomies, mini-TOC, FTS

    As the March ClickHelp release approaches, the ClickHelp team is getting more and more excited as we are eager to share with you all the awesome things we have been working on for the last several months. This sneak peek blog post is dedicated to drastic functionality improvements of taxonomies, full-text search, and navigation. Keep…

    Continue reading »
    Posted in ClickHelp Features on 2/27/2019

    ClickHelp March Release Sneak Peek: Readability Score and Reporting

    ClickHelp March Release Sneak Peek: Readability Score and Reporting

    A new sneak peek post and even more excitement comes with it! We are going to tackle a very important topic in the upcoming ClickHelp release – your user’s satisfaction with the technical docs you create. You sure have a general idea about how readable your user manuals are. But, does this idea have any…

    Continue reading »
    Posted in ClickHelp Features on 2/22/2019

    ClickHelp March Release Sneak Peek: Enhanced Review Process

    ClickHelp March Release Sneak Peek: Enhanced Review Process

    Today, we are really excited to give you this exclusive sneak peek into the ClickHelp March release. We have prepared numerous product enhancements and feature updates, and we are eager to share them with our clients! More sneak peek posts are coming in the following weeks. Reviewing is a crucial part of technical writing. And,…

    Continue reading »
    Posted in ClickHelp Features on 2/21/2019