Technical Writing Blog
1.42K subscribers
568 photos
1 file
566 links
ClickHelp — online documentation tool for technical writers and teams. Create, translate, and publish documentation easily in one portal!

Get your FREE trial 👉 https://goo.gl/NahsT2
Download Telegram
Most people expect technical documentation to be one hundred percent neutral. We know that technical writers should 'terraform' the most complicated pieces of data and turn them into structured user manuals. There's no place for 'I', for bias, for being opinionated in techcomm. Or is there?

In fact, we touched upon a similar idea in our recent post about adding metaphors to user manuals to humanize them. That's not the only reason for using this stylistic device, but it is an important one.

However, there is a way to turn things around called advocacy technical writing 👇

https://bit.ly/2RlzbZ8
Misconceptions are as annoying as hell. Especially when they are connected with something you love and do for a living. Let's take a look at common misconceptions about techcomm and bust them!

https://bit.ly/36zZxLl
Aviation is a rapidly developing high-tech field. Technologies used in modern aviation are mind-blowing. And, they require technical documents. To be more precise - every little detail requires a document when it comes to planes and other aircraft. Let's take a look at what it means to be a technical writer in aviation.

https://bit.ly/37KpSrv
Today we will look at a question that seems to be bothering techcomm newcomers and not only them: how do I discipline myself? Especially when the backlog keeps growing, I have to be chasing fickle deadlines constantly and procrastination is calling me.

https://bit.ly/36SpDZX
How can you tell a professional tech writer from a newbie? It is always easier to figure out what the pros should do than actually go into what they never do. This article will give you the right idea of a true techcomm pro. Use this guide to your benefit and get one step closer to achieving your goals.

https://bit.ly/2w1WkaV
Being replaced by a machine is a common fear several generations share. Technical writers included. And, it feels like now is the perfect time to re-evaluate the chances. Especially, since we seem kind of close to a real breakthrough with AI. However, this is not a brand new feeling 🤖

https://bit.ly/31Mc3q1
Marketing is viewed as a separate field in business. Marketing teams are responsible for attracting potential clients and taking action to persuade them that the product holds the solution they were looking for.

However, a lot of factors influence this process, and often they are out of the marketing team's scope. Let's take a technical documentation portal as an example. The marketing team can advise on how to set it up, of course. But it is unlikely that they will throw themselves into this task. It is mostly the responsibility of the documentation team anyway. And, as a technical writer, you have no choice but to acquire a general understanding of the marketing side of things. Otherwise, you can ruin customer experience.
https://bit.ly/2SL65Sj
Fonts are an important part of any documentation design. That is basically the body of the written text. Choosing a font directly influences text perception by readers: its readability and accessibility. Which, in its term, can change the learning curve and product adoption.

In this post, we will cover what you should pay attention to when playing around with fonts and their properties.

https://bit.ly/2HAsAnO
Every year SoftwareSuggest arranges awards. It is a stamp of approval awarded to software by SoftwareSuggest experts. They award it to the software that is exceptional in what developers offer.

We are happy to announce that ClickHelp, an online documentation tool, has become a two-time winner of the following awards given out by the SoftwareSuggest experts: Great User experience Software and Customers' Choice Software awards!

🏆🏆

https://bit.ly/38GuFe3
Sometimes, we get so used to looking at things from a certain perspective that it is getting increasingly harder to see how it may look for others. For instance, no matter how important it is for technical writers to think like readers to deliver better user manuals, it can be a tough call.

Let's shift our perspective and try to understand how people actually read technical documentation. It will help to get the idea of how the docs can be improved.

https://bit.ly/2wvBG2R