Technical Writing Blog

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…

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…

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…

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,…

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…

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,…

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…

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…

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…

Nowadays, almost every brand has a range of accounts on different social media platforms, and we, as tech writers, can’t miss a chance to look into the matter and see for ourselves whether it could be a useful tool for us to promote documentation or not. Why Would You Need to Promote Your Documentation? Let’s…