Technical Writing Blog

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…

In today’s digital age, product documentation has become an essential component of a successful business. However, it’s not just about having clear and concise documentation for your customers. It’s also about creating a seamless experience for them when accessing this information. That’s where branding comes into play. In this article, we will explore the importance…

If you are an API technical writer, chances are you have heard of Swagger. In this blog, we will explain the main tools that Swagger offers, the advantages of this powerful platform, and ways to connect your API documentation created in Swagger with your user manuals. What Is Swagger? Swagger is a set of open-source…

Choosing a technical documentation tool is not an easy task. For instance, you should compare a lot of platforms and make a final decision. This blog will explain the difference between Confluence and ClickHelp so you can choose an appropriate tool for your needs. What Is Confluence? Confluence is a web-based collaboration and document management…

As your business grows, the knowledge base of your company expands, and your employees might need new tools to manage it. Technical documents stored on PCs often get lost, or people just forget to share them in the common folders accessible to most users. Such a situation is typical for companies whose information is stored…

It is a well-known fact that English is the dominant language on a stage of global e-commerce, but this is not the case when one size fits all. It can be challenging for a company to launch its product or service to an international market dominated by local competitors. So software localization can help to…

What Is DITA? DITA is short for The Darwin Information Typing Architecture. It comprises the principles of specialization and inheritance that are much like the Darwinian theory. “Information typing” means the classification of information into topics, not “typing” as in keyboarding 🙂 “Architecture” is a hierarchy of elements or adaptable set of structures. It provides…

An FAQ is a list of frequently asked questions about a product or a service. They can be found on websites, occupy special forum sections, or be part of an online documentation portal. Fun fact – an FAQ section doesn’t necessarily cover questions that are frequently asked. It can be just any descriptive or technical…

ClickHelp is a tool for technical writers that offers enormous possibilities. We would like for each user to be able to use our software to its full potential. To help with that, I’ve come up with a list of mistakes to avoid when using ClickHelp. This list is perfect for our new clients, but even…

Let’s talk about versioning user manuals today. This concept has far more use cases than one might think. We will name some of the most popular ones and talk about the means ClickHelp, a cloud solution for help writing, offers to solve this! ClickHelp is based around the idea of reusing content and creating multiple…