Back
to top

    Technical Writing Blog

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

    Understanding Medical Technical Writing

    Understanding Medical Technical Writing

    Health care is an important field for technical writing. Modern medicine is extremely techy and quality of user manuals is expected to be high as human lives and well-being depend on it. Medical Technical Writers The healthcare industry traditionally employs many technical writers. And it is safe to say that the trend is going to…

    Continue reading »
    Posted in TechComm Career Path on 3/7/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

    Adapting Technical Documentation for Mobile Devices

    Adapting Technical Documentation for Mobile Devices

    Quite a while ago, technical documentation became accessible online for many products. And, it was an important step in the evolution of technical writing. People didn’t have to store printed technical documentation anymore. In case a device was out of order, they didn’t have to organize a search party for that old I-was-sure-it-was-in-that-drawer user manual….

    Continue reading »
    Posted in Technical Writing on 2/15/2019

    How to Organize Your Workplace

    How to Organize Your Workplace

    Take a look at your workspace. What are your thoughts? Do you feel encouraged and full of productive energy to create superb technical documentation when you are looking at it? If the answer is ‘yes’, then this article is probably not for you; but you could still give it a read, because the right answer…

    Continue reading »
    Posted in Education on 2/12/2019

    Best Practices for API Documentation

    Best Practices for API Documentation

    API is on top of its game now. The market is growing, the products are being developed and improved. This means that API documentation will be in the center of attention in the years to come, as well. API documentation stands out as a pretty unique product due to specifics of the field. Therefore, we…

    Continue reading »
    Posted in Technical Writing on 2/8/2019

    The Internet of Things and Technical Documentation

    The Internet of Things and Technical Documentation

    The IoT market is currently exploding with millions of devices online daily. In a couple of years, we will be talking about billions of such devices. And, since there are no viable reasons for the IoT to stop developing at this crazy pace, we will eventually end up with hundreds of billions. This is quite…

    Continue reading »
    Posted in Technical Writing on 2/5/2019

    Instructional Design and Technical Writing

    Instructional Design and Technical Writing

    Instructional design is perceived as something separate from technical writing. Let’s take a closer look at this field and see for ourselves whether a line should be really drawn between techcomm specialists and instructional designers. Definition of Instructional Design Instructional design is a process of developing and delivering learning materials and everything in between –…

    Continue reading »
    Posted in Technical Writing on 2/1/2019