ClickHelp Technical Writing Blog

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

One of the most common things users say about technical documentation is that it describes the information they already know. This fact reduces the value of the content to the minimum. Now, when thousands of software products and cloud services Continue reading »

A knowledge base (KB) is a brilliant source of information for users. That is an excellent repository - store, share, and organize the information the way you want and need. You can build it for both external (customers) and internal Continue reading »

Being a technical writer means getting writing tasks from other departments, not only your manager. It's not like you don't have enough on your plate already, but since you are really good at creating documentation, helping other teams out seems Continue reading »

Robots are often described as some kind of intruders in fiction books, movies, and games. They are soulless creatures that were invented by humans with the best intentions in mind, but it rarely ends well. If there’s no apocalypse, then Continue reading »

This is the era of SaaS. The idea of software has changed a lot for the past I'd say ten years. Sure, we still install software on our PC's and laptops, but we tend to use services much more: Google Continue reading »