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
Agriculture was the key element in the development of our entire civilization. It started thousands of years ago with gathering wild grains and later planting them. A lot of significant inventions were happening around agriculture and that enabled countries to grow and prosper. And up till this day, we feed on the same basic things. Since it plays such a big role in the modern world, too, agriculture is one of the most high-tech industries with constant demand for innovations.

And if there’s technology, there’s technical writing. If we take a look at the pace with which the new technologies emerge and need to be adopted by the industry, it is easy to see how agriculture needs professional technical communicators to leverage this process.

https://is.gd/xh2NHC
Readability is something your readers should not concern themselves about. It is your job, as a technical writer, to make sure that ‘OMG this is so difficult to read’ never crosses their mind. This is not something, however, that can be approached mindlessly and solved just like that. To improve readability, first, you need a deep analysis of your text because it relies on a number of things.

When you get a clear picture of where you are standing at the moment, you can start working on a plan to improve it. Further on, we will break down the main factors impacting readability, starting with the big one - words.

https://is.gd/M7u3xi
Remember when you had to actually install software on your PC to write technical documentation That wasn't entirely terrible, but if you think about it... you had to worry about so many unnecessary things like system requirements, enough free space, security, and many more. Working from home wasn't such a big thing until recently, but it would be just as troublesome when dealing with software.

You would need to get remote access permissions, otherwise, you would have to install the software on your home PC, so all the above-mentioned things would give you trouble, plus, most likely, you would have to carry an extra license for the software in your pocket. We are moving away from all these issues now when documentation portal as a service comes to play. It is a new, easier way of authoring technical texts of any kind with a huge emphasis on convenience, efficiency, and security.

https://is.gd/aJJTX0
The ability to work with SMEs efficiently makes a huge difference in technical writing. A lot of things like depth, clarity, and precision of descriptions in user manuals depend on how well you communicate your requests to an SME and how successful you are at interpreting and follow-up questions.

Today, we will try to come up with a perfect scenario of tech writer/SME communication. It is clear that both parties are equally responsible for the outcome, but taking what you can into your own hands and fixing up the process is a good choice.

https://bit.ly/35RLAJS
Millennials are here. This is how generations work - one minute they are toddlers, the next - your company’s executives. We are talking about practically the whole world and it is hard to believe that people from different cultures and backgrounds could have any resemblance. But with globalization orchestrating our lives there’s not that much to question anymore.

And, no wonder that millennials are going to constitute a huge piece of your technical documentation audience. It is true for any industry. But the main point of focus should be on everything IT.

Today we will try to see how to make sure millennials are satisfied with the user manuals you write.

https://bit.ly/2LLnvuW
Technical writers are everywhere. You might not see them, but the results of their work are omnipresent. Every piece of equipment you use, every tool is created according to technical documents written by someone. Even the jobs you take have documentation that holds their processes together.

Since they are out of everyone’s sight, technical writers themselves think that they’re desired in the IT industry only. However, it's a misconception - technical writers are needed everywhere from IT to manufacturing.

To help you find a new niche, we created this ebook, where you find answers to such questions as:

✏️ How to jump technical writing industries?
✏️ What industries hire technical writers?
✏️ What skills do you need to build?
✏️ How can you get the job in a new sphere?
✏️ And much more.

https://bit.ly/3bSw1TI
The sports industry is rarely named among the top places for tech writers to work. But, actually, there’s a lot of technical communication going on there. Today, let’s take a look at what a technical writer is needed for in the sports industry.

https://bit.ly/3es0aLb
Technical documentation teams can have different approaches to doing many things. A lot of the stuff can be altered in help authoring, leaving that to personal preference, but when it comes to choosing a place to store user manuals, one needs to be really careful.
In this post, we will talk about using a CMS for delivering technical docs to readers and why this is not ideal for the case.

https://bit.ly/3eONJJJ
Sometimes, you need to become a technical writing pioneer. This often happens at startups or, perhaps, your company decided to terminate contracts with outsourcing help authoring companies and wants to start its own thing going.

Being the first technical writer in a company has a lot of challenges. But don’t fret - as long as you have a plan, you will succeed. This article will help you stay confident through the process of building technical writing from scratch. Just keep calm and follow the guidelines :)

https://bit.ly/2AcDO1Z
Do you enjoy reading as much as I do? The best part about books is that you can find one for any cause. Our today’s cause is technical writing. And, there are a lot of great books directly about tech writing, or there are the ones that can provide you with knowledge in other spheres that helps a lot too, starting with things like grammar and punctuation and reaching as far as marketing and time management.

I know a lot of people who not only benefit from the information they get from books but just find the whole book-hunting process fun. In this post, I am going to provide you with several book titles.

https://bit.ly/2N3aVYP