Technical Writing Blog: Articles and Useful Information
Back
to top

Technical Writing Blog

Grow your technical writing expertise with industry news, best practices, articles, product updates

Micro Content in Technical Writing

Micro Content in Technical Writing

Many content creators, technical writers, and other authors face the problem of content form choice. Content forms have the following classification: Long-form content Short-form content Micro content Long-form content provides a lot of information on the topic to say nothing of its depth. The length may vary from 700 to 2000 words. The most vivid…

Continue reading »
Posted in Technical Writing on 10/27/2021

Technical Editor: Role, Skills, and Responsibilities

Technical Editor: Role, Skills, and Responsibilities

The field of technical communication is vast. It encompasses forms of communication that can help users accomplish a defined goal or task. Strictly speaking, any text intended to convey information about using technology is considered “technical communication.” Technical communicators specialize in website design, graphic design, marketing communications, online help, print production, training, and technical documentation….

Continue reading »
Posted in Technical Communication on 10/20/2021

Visual Instructions: Benefits, Industries, Tips

Visual Instructions: Benefits, Industries, Tips

Studies show that people easier perceive picture instructions than text. I often notice things like that: you may have a brilliant cookbook, but you don’t use it if it contains text only. You are looking for a how-to video or a simple step-by-step instruction with pictures. They are more efficient. The same happens when we…

Continue reading »
Posted in Technical Communication on 10/13/2021

How to Test the Usability of Technical Documents

How to Test the Usability of Technical Documents

Technical documentation is one of the main components of the software product in any respectable company. But not all organizations devote enough time to develop effective documentation. Oftentimes, there are situations when a software product is smart and ingenious, but the documentation is feeble and helpless. Since a technical document serves many purposes and can…

Continue reading »
Posted in Technical Writing on 10/6/2021

Technical Writer Job Description, Skills, and Salary

Technical Writer Job Description, Skills, and Salary

Every organization must be able to use technical writers as the first line of users who can give honest feedback about the usability of the product. — Mridula Menon, Technical Documentation Manager at ServiceNow Technical writing is all about learning, teaching, and telling. If you are a born explainer of things, technology-inclined, and have a…

Continue reading »
Posted in Technical Writing on 9/29/2021

Writing a Technical Description: Best Practices

Writing a Technical Description: Best Practices

Clear communication is essential for both developers and end-users. The absence of clear technical descriptions can lead to significant challenges. For example, when a company adopts a cloud storage platform without providing a detailed guide on uploading, sharing, and managing files, employees may encounter confusion, reduced productivity, and even data loss while navigating the system….

Continue reading »
Posted in HTML & CSS tips on 9/22/2021

All You Need to Know About Software Localization

All You Need to Know About Software Localization

It is a well-known fact that English is the dominant language on a stage of global e-commerce, but this is not the case when one size fits all. It can be challenging for a company to launch its product or service to an international market dominated by local competitors. So software localization can help to…

Continue reading »
Posted in ClickHelp Features on 9/15/2021

Create Note Boxes in Online Documentation with HTML and CSS

Create Note Boxes in Online Documentation with HTML and CSS

To tell the truth, technical documentation is a boring thing to read. If it contains text only, it is even worse. Users hardly ever read docs from cover to cover. They scan them. It looks like that: they jump from title to subtitle, or to text elements that stand out visually (bold or italic font),…

Continue reading »
Posted in HTML & CSS tips on 9/8/2021

How to Create an Instruction Manual?

How to Create an Instruction Manual?

When people hear the phrase instruction manual, they think about different step-by-step explanations of how to control devices, assemble furniture, repair computer accessories, do routine maintenance of equipment, etc. Such manuals are one of the most common and important things in technical writing. Whenever you purchase anything from electronics or any other product, there is…

Continue reading »
Posted in Technical Writing on 9/1/2021

10 Most Important Skills of a Technical Communicator

10 Most Important Skills of a Technical Communicator

What Is Technical Communication and Who Is a Technical Communicator? The definition of technical communication is the following: it is a type of communication that is aimed at providing readers with clear and accurate information on how to use and maintain products, complete tasks, operate equipment, etc. It is a means of conveying technical information…

Continue reading »
Posted in Technical Communication on 8/25/2021