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
We recently posted an article on using parallelism in technical writing and this was kind of thought-provoking. Parallel structure is one of the most commonly used literary devices and while its role is a bit different in literature and help authoring, it proves to be useful in both fields.

So, in this article, we are going to analyze more devices pertaining to literature to understand what can be used by technical writers to improve the quality of their content.

https://bit.ly/2QnGcIW
Do you have any second thoughts when spelling out things like two million three hundred thousand kilos? Or, on the contrary, when you prefer numerals in sentences like:

Creating a new documentation portal will take you no longer than 1 minute!

These sentences are grammatically correct, but something seems off with how numerals are expressed. In our new article, we will provide you with several guidelines on how to make numerals in your technical documents friendlier based merely on common sense and expertise.

https://bit.ly/35j0lDQ
The 11 most common technical writing mistakes we hope you don't make:

πŸ“Œ Poor Design/Layout
πŸ“Œ Lack of Mobile Device Support
πŸ“Œ Ignoring People With Disabilities
πŸ“Œ Poor Maintenance
πŸ“Œ Inconsistency

More points are in our new blog post! πŸ‘‡
https://bit.ly/37wXsRR
Usability is a term widely used in web and software development. Let’s see how technical documentation fits in. Usability can be applied to printed docs in terms of how easy it is to find what you are looking for (the Index, the contents), how well the technical text is written, the quality of the paper it is printed on, how durable the cover is, etc.

But we are mostly interested in usability from the perspective of online documentation portals. To understand what usability is for an online user manual, let’s see what it isn't.

https://bit.ly/2OYB1wL
There’s a joke about Google projects that people learn about only when their shutdown is announced. So, Google Translator Toolkit is soon shutting down. Should we be concerned about the future of translation services? πŸ‘‡

https://bit.ly/2QRU4eB
The Black Friday sale is upon us. And, this is the perfect time to buy New Year presents for your technical writing friends! Or, just any presents really - tech writers have birthdays every year as well ☺️

We gathered some gift ideas for you in this article: https://bit.ly/2OThygI
Technical writing is evolving steadily. It moves from paper to PC and mobile screens refusing to cause damage to forests; it offers more options for people with dyslexia, the visually impaired, people with various kinds of special abilities. Wouldn't it be simply natural for technical documents to become minimalist? πŸ€”

https://bit.ly/2DIwI3m
We are mostly trying to show the bright side of being a technical writer on our blog. And, we honestly believe this is a great role with a nice entry-level salary, good possibilities for personal and professional growth, an occupation that can help you get into basically any industry.

A lot of good stuff is going on in the techcomm community all year round. However, today we will take a look at what makes technical writers cringe at work - the pitfalls of being a techcomm specialist.

https://bit.ly/34UkuAs
UX as a term is used more often when talking about user interfaces, but it can be applied to any object a human can interact with. Being an important part of the user journey, technical documentation deserves a special mention in terms of UX. Today, we will give you several tips to make your user manual UX not less than brilliant! πŸ’Ž

https://bit.ly/2Prt4jK
Medical writing sounds like an excellent choice of occupation. It is connected to such noble professions as a doctor or a scientist on the one hand, and it is technical writing on the other. Today we will give you an insight into this job. By the end of this blog, you will understand what it takes to be a medical writer and get a full understanding of whether this is something you'd like to do.

https://bit.ly/35s2NIK