Technical Writing Blog
1.44K subscribers
510 photos
1 file
508 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
These days many working environments demand collaborative writing and editing of documents; such collaborations are simplified.
Let’s compare two approaches to content creation: collaborative authoring and topic-based authoring and see the difference.
https://is.gd/FgvM3s
Creating an informative SDD is halfway to creating a high-quality and helpful piece of software. It is a good opportunity to quickly figure out your team’s way without losing months wandering in darkness. I hope this post will give you new ideas and thoughts on how to write an SDD and customize this process to your product’s special features.
https://is.gd/dCsgjH
The current demands of technical writing don't integrate with long-established processes anymore.
When the amount of content the companies are creating is growing exponentially, the question arises: how do we organize all the documentation?
The answer is - structured authoring or its alternative. Read more in this article.
https://is.gd/UBVGWw
What is a technical report, and how to write it? Both newbie tech writers and experts often search for this information.

Our post will give you the most comprehensive definition of this term, smart classification of report types, and tips to write it!
https://is.gd/FYQxH0
Still looking for a better documentation tool but have no time for testing?
Request a 45-minute ClickHelp Demo.

Save your time! We'll tell you everything about our features and benefits!

Sign up for demo https://is.gd/WgV9Ls
The Agile methodology gives you the ability to make improvements while you’re documenting your agile project.

As for Scrum and Kanban practices, they both can help you make better documentation more efficiently.
https://is.gd/m08XwM
Still creating technical documentation in MS Word?
Learn how to work more efficiently.

Request ClickHelp demo right now!
We'll tell you all the pro secrets!

Sign up for a demo https://is.gd/WgV9Ls.
In our new post, you'll find answers to these questions:

Who is a technical communicator?
What do technical communicators do?
What skills are a must for a technical communicator?

Read in our new blog ➡️ https://is.gd/5JmyOa
When you buy any product, there is always a user instruction manual included.
Let’s see how to write instruction manuals so that they could positively communicate with your customer and increase your company’s credibility.

Read in our new blog ➡️https://is.gd/F62dbK
If you still don't know how to create Note Boxes for technical documentation with HTML and CSS, this post is for you!
Here are the best tips both for those who are not familiar with coding and for experts.
➡️Read in our new blog ➡️https://is.gd/d8Y0IN
Do you know what software localization is and what role it plays in your company’s entering the global market?
➡️Read in our new blog ➡️https://is.gd/TXF7Ev
Each technical writer wonders how to create an efficient but enjoyable technical description. That’s always challenging, and there is no universal instruction.
But here is a list of things you should keep in mind to produce nice technical descriptions.
➡️Read in our new blog ➡️ https://is.gd/2UfAcD
Who are technical writers, what do they do, what skills do they have?
➡️ Check out examples of their job descriptions and their average salary level in our blog.
https://is.gd/wPEPxe
Technical documentation is one of the main components of the software product in any respectable company.
That’s why you need to conduct usability testing of documentation. It helps you find out how well your document works for the people who use it.
➡️ Read in our blog➡️ https://is.gd/HoGpRj
Studies show that people easier perceive picture instructions than text. They are more efficient and work better than words.
So what are visual instructions, and how are they used?
➡️Read in our new blog ➡️https://is.gd/yXPa5N
Although technical editing covers the same wide variety of subjects, contexts, and materials as technical writing, a technical editor has a special role in content creation.
Read more in our new article. https://goo.su/8JFt
Online technical documentation is now available to almost everyone. It is nothing more than content that can be used as a marketing tool. In order to make your tool work effectively and deliver value, we recommend that you get acquainted with our Ebook.

From this e-book, you'll learn:
📗SEO tips for technical writers.
📗How to use Google Analytics in technical writing.
📗Tips for improving your online documentation to make it SEO-friendly.
https://goo.su/8msS
Micro content isn’t something widely known, but it is widely used. It allows to boost the performance of technical documentation, and, of course, is highly appreciated by users.
Read our new article to learn what micro content is and how to create it.
https://goo.su/8sID
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://bit.ly/3mpekDw
Product description contributes to a positive customer experience and the credibility of your store. So, optimize your product descriptions; otherwise, you’re certainly splashing money.
Find out how to do it, read our new blog post.
https://bit.ly/3wf0nvw
The main goal of a technical writer is to create user-friendly documentation. In order to do this, you should figure out the level of knowledge of your target audience on the subject in question. But how to be sure that your documentation will be clear for your target audience?
Here is where readability and text metrics step in.
In this ebook we will tell you about:
📓 Why metrics are important in tech writing.
📓 How to measure the effectiveness of your documentation.
📓 Top 5 text metrics to consider for user documentation.
📓 How to review technical documentation.
📓 Where to get all the necessary metrics.
🗒 And much more! https://bit.ly/3nZz4BF