Technical Writing Blog

A QR code or a Quick Response code is a type of matrix barcode first designed in 1994 in Japan to track vehicles in the automotive industry during the manufacturing process, not as a helpful marketing tool we see today. A barcode is a machine-readable optical label with information about the item to which it…

This is the second part of our introduction to the “Markdown universe”. In our previous post, you can learn more about Markdown history. Today we are talking about the variety of editors for Markdown. Variety of Markdown Editors Nowadays, Markdown comes all-in with tools that don’t demand you to learn the syntax instantly, so even…

Do you know that 90% of users prefer instructional videos when they want to learn something? Just imagine how many people watch YouTube every day looking for How-to videos to say nothing about those who choose video courses. Not only individuals tend to learn by watching video content, but even companies also instruct their employees…

Understanding the distinction between process and user documentation is crucial. One guides internal workflows; the other empowers end-users. Both are essential, but they serve different purposes. — Elmira Abbyasova, Head of Content at ClickHelp Technical documents are a broad category of written materials designed to convey complex information in a clear and concise manner.Have you…

It’s officially springtime! The spring is always filled with bloom, hopes for better days, and beauty. So today, we decided to talk about women in technical writing. They inspire, motivate, surprise, and compel us with their determination, creative approach, and intelligence. Women in History of Technical Communication The tech industry has been a “boy’s club”…

If you are a technical writer, I am sure you’ve got an endless backlog. It is sad but so true to life: so many tasks are to be done, and so little time! Even professionals in the sphere of task and time management may suffer from a problem like that. So, let’s figure out how…

A system for commenting on a document so that it is syntactically identifiable from the text is called a markup language. When the document is processed for display, the markup language is not shown and is only used to format the text. The “markup” term is derived from the “marking up” of paper manuscripts, the…

What is IT documentation? In a nutshell, it is a full database of all the information an IT team needs to fulfill its tasks efficiently. It should involve all kinds of key documents: detailed instructions for specific operations, onboarding docs, information about customers, standard operating procedures (SOPs), and many other things. Informative IT documentation must…

The realities of modern life demand constant learning of new trends and tools almost in every profession. Nowadays, conferences are a part of such knowledge acquiring. So, if you want to stay relevant as a professional in tech comm, you should definitely visit some of them. Keeping in mind the unprecedented situation of 2020, many…

Do you often watch How-to videos on YouTube? I am sure you do it from time to time. As for technical communication, video has already become widely spread in user manuals. Statistics show that up to 75% of users do watch video content while almost everyone neglects text. Let’s discuss in this post how to…