Technical Writing Blog
1.4K subscribers
477 photos
1 file
475 links
ClickHelp — online documentation tool for technical writers and teams. Create, translate, and publish documentation easily in one portal! Get your FREE trial here - https://goo.gl/NahsT2
Download Telegram
Best Tips to Create Valuable Software Documentation

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.

Nowadays, the content telling simply how to press the buttons is outdated. What users are looking for is support in their decision-making process. It means that technical documentation needs a more complex approach.

https://is.gd/SwqYbS
Should You Restrict Access to Your Online User Guides?

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?

Should an employee handbook or policy and procedure manual be public? Definitely, not. They are not meant for public use. That’s when limited access to documentation is required.

https://is.gd/F69LKQ
Looking Back on 2020 with ClickHelp

Everyone and their brother didn’t say how hard this year has been. We decided to take a different approach and do some math instead. We calculated resources, blog posts, and ebooks to give you some curious facts and food for thought.

https://is.gd/bgxAOF
2021 Trends in Technical Writing and Software Documentation

As everyone says today, 2020 has drastically changed everything: our private lives, hobbies, relationships, habits, and careers. Technical writing is no exception. Unexpectedly, the pandemic has brought so much new in this sphere that we all need to figure out what is going to be a trend next year.

https://is.gd/acckBc
We wish you HAPPY NEW YEAR!

However strange and tough 2020 has been for most people, we strived so much to be useful for you. That's why we wrote 71 blogposts.
So our New Year's resolution is to please you even more!
We wish you all good health and well-being next 2021 year!
Careers of the Future in the Software Field

Last year was a huge challenge for the whole world. On the one hand, it is sad and hopeless but, on the other hand, the global crisis gave us a great opportunity for growth and development - new careers and positions are mushrooming in the software field as humanity needs more and more software products to work and live.

Without further ado, here are the jobs of the future!

https://is.gd/hFkzHJ
ClickHelp as a DITA Alternative

Implementation of such standards as DITA is a long-range project that consumes time, money, and human resources. And grasping at new trends because everyone is following them is not the right way to go. Instead, maybe you need to take time, look around, and find another alternative for your documents to be structured.

ClickHelp might be just what fits you best - content reuse and dynamic output are paired with the ease of use for better documentation delivery.

https://is.gd/XG083A
Not sure what to read on the weekend?

We recommend that you get to know our Ebook. This Ebook has answers to all your questions about starting a career in the technical writing field like:

✔️ What technical writers do?
✔️ What skills do you need?
✔️ What background should you have?

https://is.gd/FI7Mwx
Succeeding as a Technical Writer

The field of technical communication continues to grow. In this connection, an increasing number of people enter the profession of a tech writer. That’s why a technical writer must always improve relevant skills to outstand among other applicants.
Here are some tips to succeed in that.

https://is.gd/DSxBTA
Types of Technical Documentation

The main aim of technical writing is to help users achieve their goals by using a product. It’s possible only through clear and easy-to-interpret documentation. That's why there are so many different types of technical documents. Whether you’re a novice or experienced tech writer, you should know the most popular types of documentation because each of them implies different content, style and so on.

In this Ebook we will cover the following topics:

How to write effective documentation.
Good and bad technical documentation examples.
Types of technical documentation by readers and by industry.
Other popular types of technical documents like API documentation, hardware manual, software documentation, and much more.

https://is.gd/t1RlKh
Latest Tips on Using Video Content in Technical Documentation

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 watch video content while almost everyone neglects text.

Let’s discuss in this post how to implement video to make your technical documentation clear and understandable.

https://is.gd/zNbdmo
Are you into attending online conferences in 2021? Which side are you on - online or offline format?
anonymous poll

I vote for online conferences! – 12
👍👍👍👍👍👍👍 40%

Makes no difference for me as long as it's free of charge – 10
👍👍👍👍👍👍 33%

I'm for offline format – 7
👍👍👍👍 23%

I'd say neither. There're all useless – 1
👍 3%

👥 30 people voted so far.
Technical Writing: Readability and Text Metrics

🤔Don’t know whether your readers will understand your documentation properly? Use readability and text metrics!
🤓They will help you measure the effectiveness of your documentation that will give you the idea of what you should improve.

👉🏻This Ebook contains tips on how to review technical documentation right, top 5 text metrics to follow, and the like.
Much more: https://clck.ru/T2tZz
Online Conferences for Technical Writers 2021

The realities of modern life demand constant learning of new trends and tools almost in every profession. Nowadays, conferences are a part of such knowledge acquiring. So, if you want to stay relevant as a professional in tech comm, you should definitely visit some of them. Keeping in mind the unprecedented situation of 2020, many events have decided to shift to virtual.

And, here is the list of online conferences for 2021.

https://is.gd/p3hEN2
SEO and Technical Writing

Technical documentation isn't only created to convey a technical writer's ideas to an audience but it also can be used as a marketing tool.

This Ebook will help you make way to marketing opportunities since it covers a wide range of questions like:
How to use Google Analytics in technical writing
How to make your content SEO-friendly

➡️➡️Click to download: https://is.gd/ZYNcDx
Using Diagrams in IT Documentation: Best Practices

In a nutshell, IT documentation is a full database of all the information an IT team needs to fulfill its tasks efficiently. Here appears the capacity to develop your business in general.

Using diagrams in IT documentation is an awesome solution to make information clear and concise. They are suitable for all kinds of users. If you know best practices in this field, you are able to create brilliant documentation, especially with the right tools at hand.

https://is.gd/0rAxrj
Techcomm Industry: Job Analysis and Forecast

➡️Want to get the job in a new technical writing sphere?
➡️Learn what industries hire!

There is a huge misconception about technical writing - people think these professionals are desired only in IT. If you want to find an interesting niche to start your career as a tech writer or you want to get the job in a new sphere, read our industry analytics report.

➡️➡️Click to download: https://is.gd/6Vj6QV
Markdown: History, Development, Aspects

This article will give you a comprehension of the markup languages, their categories, and utilization.
The Markdown language is of special interest to us here. Join the discussion.

https://is.gd/rGW7lB
Are Your Manuals Ready for Mobile World?

Nowadays people prefer smartphones to look something up because it’s the quickest way to learn something.

So, are you sure your content is responsive? This Ebook will help you optimize your content according to the most popular screen resolutions.

https://is.gd/DqzHTN
How to Manage Your Technical Writing Backlog

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! Let’s figure out how to cope with piling up tasks to increase your company’s productivity.

https://is.gd/9mXcXI