Technical Writing Blog

Facile pen, subject knowledge, and ability to transform technical subtleties into clarities for the end-users – these are must-have talents for a technical writer. Indeed, there’s more to it – we have already written about the skills of a good tech writer. Today we’ll focus on how technical writers start a new documentation project, what…

New words and phrases tend to somehow miraculously seep into our everyday life. This is regular for the world of modern technology. And as a person working closely with words and technology, have you ever wondered how these words are born? Some of the technical terms contain entertaining facts, so you can impress your friends…

Technical drawing today is an essential part of technical documentation. Such industries as civil engineering, architecture, shipbuilding, aerospace engineering, astronautics, or medical engineering can’t help using technical drawings. Those technical writers who work on documentation like that, are to be able to create technical drawings using special software. I should say, that is another must-have…

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…

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…

Implementing password-protected user guides is something that any company may need. You may ask why someone would need to hide their online user documentation behind a login page? The answer is simple. Documentation can be different. Let’s say we talk about a coffee machine manual – it has to be public. The more users have…