Technical Writing Blog
1.43K 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
While the entire world is moving in the direction of secure Internet connections and using HTTPS for almost all web sites, people may become less cautious believing that they are secured. This introduces attackers with easier ways to steal private information or take over users’ machines control.

As Google is always concerned with user privacy and web content security, last October they announced measures to tighten security rules in the Chrome browser to deal with the mixed content problem. Step by step, they made Chrome block all HTTP resources (images, videos, etc.) in HTTPS web pages if these resources are not available over a secure connection.

https://bit.ly/3fDruqh
Let’s talk about versioning user manuals today. This concept has far more use cases than one might think. We will name some of the most popular ones and talk about the means ClickHelp, a cloud solution for help writing, offers to solve this!

ClickHelp is based around the idea of reusing content and creating multiple versions of the same documentation project. This gives you a shortcut to faster and better help authoring right off the bat. With content reuse, all technical texts you are creating at the moment have great potential to make your life easier tomorrow.

https://bit.ly/2Z1IYWR
All technical writers are famous for being meticulous about grammar, style, and punctuation. If we count the time wasted on checking grammar in user guides, it will probably drive us to the conclusion that this is one of the most important parts of the process.

The main aim of technical writing is to deliver a clear message to their audience, not just produce grammatically correct technical texts. Let me explain further how proofreading can become a time-devouring monster that will interfere with your best-laid help authoring plans. And, hopefully, at the end of this blog, you will learn how to fight it.

https://bit.ly/2NM1I7y
Technical documentation is viewed as something handy and nobody would ever doubt that it is necessary to have one. But technical writers are faced with the reality of people underestimating what they are doing. Sometimes, it is important to go through the most basic and down-to-earth things like, if you save on tech writing you will potentially lose a lot of clients and money.

I am going to point out three major things that technical writers help piece together for a company: product adoption, case deflection, and overall user satisfaction with a product.

https://bit.ly/2VXFi7M
ClickHelp is a tool for technical writers that offers enormous possibilities. We would like for each user to be able to use our software to its full potential. To help with that, I’ve come up with a list of mistakes to avoid when using ClickHelp. This list is perfect for our new clients, but even those of you who have been with us for many years might find something useful in this article, I am sure.

https://bit.ly/3j4yjE2
We have awesome news! A new ClickHelp release is here! This post will take you on a journey to get to know ClickHelp Gecko better - I am sure you are going to love it.

ClickHelp Gecko brings in improvements in many product areas: more flexible permissions, better table customization, new reader UI templates, better performance, and more. We have been working hard on this release and are very eager for it to go live. Without further ado, ladies and gentlemen - ClickHelp Gecko!

https://bit.ly/2ZQCagl
Would you like to start your own tech writing agency? This is a big decision and a lot of thinking needs to happen. Understandably, this is not a solution for everyone and this is completely fine.

However, if you are entertaining the possibility, this post can be useful for you - we are going to talk about the steps one should take to start a tech writing business.

https://bit.ly/3f6f6P7
Technical writing is a complex process that requires proper orchestration. We can see how it is evolving with time, too. Technical writing is now more integrated into user experience than ever before. The thing about integration - you can’t do this on a micro level, you need the bigger picture.

So, a very definite set of responsibilities has been shaped. Something a bit different than just a tech writer. This role is called ‘Information Architect’, and today’s blog will be dedicated to this phenomenon.

https://bit.ly/3hRo7gJ
At first glance, this blog post is more fitted for people currently fulfilling the position of a manager in a documentation team. However, if you are a technical writer now, you might as well get a promotion one day to become a manager, so this material could be of interest to you, too. Or, this post also works for project leads - they share a lot of common responsibilities with managers.

In this post, we are not going to be covering soft skills of successful managers but rather analyze what constitutes this role in technical writing and how to be a great one.

https://bit.ly/33ubbt2
Can you land a job in technical writing providing no writing samples at all? I believe so, yes. But this will likely be an entry-level role. Hiring you for something more serious, your potential employers would like to see some of your work. And, in this post, we are going to be talking about the best practices in developing samples for a technical writer interview.

https://bit.ly/3itNe9u