Back
to top

    Technical Writing Blog

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

    TechComm Conferences, 2023: Don’t Forget to Sign Up

    TechComm Conferences, 2023: Don’t Forget to Sign Up

    Whether you’re a seasoned technical writer or just starting out as a technical communicator, staying up-to-date on the latest trends and best practices in your field is essential. One of the best ways to do so is to attend conferences. In the remainder of 2023, a number of great TechComm conferences are taking place around…

    Continue reading »
    Posted in Education on 8/30/2023

    Technical Writer Salaries in 2023: What to Expect

    Technical Writer Salaries in 2023: What to Expect

    Technical writing is a profession that has recently entered the vocabularies of head hunting and recruiting agencies all over the world. It is quite popular, and its future prospects are associated with the development of such technologies like AI, VR/AR, IoT, and big data. Tech writers shape the way users interact with technical content. The…

    Continue reading »
    Posted in TechComm Career Path on 8/23/2023

    Mastering the Art of Scenario-Based Writing

    Mastering the Art of Scenario-Based Writing

    In human perception, there are many unwritten laws that function almost like mathematical rules. One of these laws concerns the perception of indirect information. You may already know that information becomes more comprehensible when it is ‘wrapped’ in a story. You may have seen this law in action when explaining things to kids. Usually, it…

    Continue reading »
    Posted in Technical Writing on 8/16/2023

    Unlocking Team Collaboration with Online Documentation Tools

    Unlocking Team Collaboration with Online Documentation Tools

    Some time ago, the efforts of SaaS (software as a service) companies seemed to be dispersed across different resources. Teams had to hover from content creation to API, translation, and localization tools. This inconvenience was a problem that required an urgent solution. Naturally, the trend was towards integration, and the result was the creation of…

    Continue reading »
    Posted in Technical Writing on 8/9/2023

    Creating Secure and Access-Controlled Public Docs

    Creating Secure and Access-Controlled Public Docs

    Limiting access to documentation is a usual practice for companies who provide SaaS (software-as-a-service) products. This may sound illogical because public documentation like user guides, online manuals, and help docs enhance the product’s usability and popularity. Still, certain documents are meant for internal use only. These are SOPs (standard operating procedures), employee handbooks, company policies,…

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

    2023 API Survey by Postman: Key Findings and Perspectives

    2023 API Survey by Postman: Key Findings and Perspectives

    As you know, ClickHelp is a flexible help authoring tool, and it’s quite suitable for creating API documentation, among other things. We also provide a REST API for task automation and integration of your documentation workflow into business processes. As we constantly improve and expand the API docs features in our product, we keep a…

    Continue reading »
    Posted in Technical Communication on 7/26/2023

    Implementing Multi-Channel Publishing to Optimize Your Online Presence

    Implementing Multi-Channel Publishing to Optimize Your Online Presence

    Today, consumers are scattered across various online platforms, such as websites, social media, mobile apps, online stores, etc. Content is generated in different formats for each platform. For example, websites use HTML, while eBooks and PDF formats are suitable for online stores. Multi-channel publishing involves creating basic content and repurposing it in various formats. However,…

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

    Managing Technical Writing Teams: Tips for Performance Evaluation

    Managing Technical Writing Teams: Tips for Performance Evaluation

    Effective teamwork is vital for the success of any project, and it is particularly important for technical writers since they have to collaborate closely with developers, subject matter experts, and others to produce high-quality documentation. The combined efforts of the whole team help them see the big picture and achieve results that far surpasses almost…

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

    There’s UX Writing and Technical Writing, What’s the Difference

    There’s UX Writing and Technical Writing, What’s the Difference

    Where UX Writing and Technical Writing Overlap Traversing the vast ocean of technical writing can feel overwhelming. There are so many different nuances to consider in enhancing user experience, explaining technical products, or structuring content to meet the needs of the target audience. And like every ship, your product needs a wise captain to guide…

    Continue reading »
    Posted in Technical Communication on 7/5/2023

    Give Your Images a Voice with Proper Alt Text

    Give Your Images a Voice with Proper Alt Text

    From icons and logos to illustrations and photos, visual content is an integral part of our internet experience. It’s out of the question that it must not only be pleasant and useful but also accessible to everyone, including visually impaired people. To achieve that, you must pair your visual content with alternative text description, or…

    Continue reading »
    Posted in Technical Communication on 6/28/2023