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

    How to Use Verbs in Technical Writing

    How to Use Verbs in Technical Writing

    Let’s talk about verbs in technical writing. We are using them basically in every sentence, so it makes sense to look closer at this notion. As we all know, technical documentation is meant to be as precise and clear as possible and this can be achieved through the correct usage of verbs, as well. We…

    Continue reading »
    Posted in Education on 6/21/2019

    7 Reasons Why Your Help Authoring Tool Isn’t Good

    7 Reasons Why Your Help Authoring Tool Isn’t Good

    We get used to certain things to the point where we can’t tell whether they are good or bad. It can be hard to evaluate a help authoring tool you have been using for a while as you have gotten accustomed to its features and know the workarounds for when things go south. We have…

    Continue reading »
    Posted in Technical Writing on 6/18/2019

    International Blogger Day in Technical Writing

    International Blogger Day in Technical Writing

    Today, June 14, is the International Blogger Day. Or, is it? Turns out there is no official blogger day, but it seems that in 2004 some people did choose this day to celebrate their passion for blogging! And, for the lack of a better date, we decided to join them, because, you know what? Blogging…

    Continue reading »
    Posted in Technical Communication on 6/14/2019

    Customer Experience and Technical Writing

    Customer Experience and Technical Writing

    Technical writers are no strangers to user experience struggles. Moreover, there’s a separate position in many companies for so-called UX writers. They focus on communication with clients through written content and creating the best user experience. We also look closely into UX when searching for the perfect software for technical writers. This coin has actually…

    Continue reading »
    Posted in Technical Writing on 6/11/2019

    Localization Support in Help Authoring Tools

    Localization Support in Help Authoring Tools

    Technical writing software needs to be able to address many things. Help authoring processes are complex and unique for every company, so HATs have to be universal. One of the serious issues for help authoring tools is dealing with different languages. This problem doesn’t limit itself to just translation, but we’ll talk about this, too….

    Continue reading »
    Posted in Technical Writing on 6/7/2019

    World Environment Day and Technical Documentation

    World Environment Day and Technical Documentation

    On this blog, we are talking a lot about technical writing, all aspects of it: tech writing skills, techcomm career paths, salaries of technical writers, types of technical documentation, what it takes to deliver good user manuals, etc. And, all this is interesting as hell, and as soon as one gets involved in the techcomm…

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

    Single Sign-On for Dummies

    Single Sign-On for Dummies

    Single sign-on is a buzzword, and it has been in the computer-based industries for a while now. But, what is the exact mechanism behind single sign-on? Why do we trust it so much? There are a lot of questions around this topic, and this is completely understandable – anyone would have questions when their sensitive…

    Continue reading »
    Posted in Education on 5/31/2019

    Top 11 Technical Writing Tools

    Top 11 Technical Writing Tools

    Technical writers use a lot of supplementary tools, not just technical writing software. Some of those are complex and expensive, others are much cheaper and nonetheless manage to do their job just fine. Further you will find the top technical writing tools techcomm specialists all over the world choose to aid them in help authoring….

    Continue reading »
    Posted in Technical Writing on 5/28/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