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

Simplified Technical English (STE): Rules and Examples

Simplified Technical English (STE): Rules and Examples

There’s a notion in technical writing connected with documentation created in English called Simplified Technical English. This is quite an interesting concept that definitely deserves the attention of the techcomm community. Let’s start with a brief history of this term. Implementing STE isn’t just about following guidelines; it’s about fostering a culture where clarity and…

Continue reading »
Posted in Technical Writing on 4/29/2022

Automotive Technical Writer: Job Description

Automotive Technical Writer: Job Description

Technical writers work in a wide range of industry-specific fields like IT, banking and finance, machine building, medical equipment, automotive technologies, etc. Any industry which implies description of standard operating procedures in the form of instructions, case deflection, specifications, user manuals, and other documentation requires technical writing services. However, if you say ‘I am a…

Continue reading »
Posted in Technical Writing on 4/27/2022

Must-Follow Best Practices to Create an Internal Wiki for Your Company

Must-Follow Best Practices to Create an Internal Wiki for Your Company

In any company, there is always a standard set of questions the employees usually ask their boss, colleagues, HR, or accounting specialists. A large group of these frequently asked questions (FAQs) refers to HR issues as it concerns the internal code of conduct: regular working hours, the possibility of ‘flexible working,’ the so-called ‘non-traditional business…

Continue reading »
Posted in Technical Writing on 4/20/2022

Knowledge Base Articles: Types, Creating, and Examples of KB Articles

Knowledge Base Articles: Types, Creating, and Examples of KB Articles

Our modern world is so submerged in good products that such products don’t guarantee success. Loyal customers, on the other hand, can lend eclat to business. So the first thing to do to make customers happy is to have top-rank customer support. Not just for cases when a customer has troubles with a product but…

Continue reading »
Posted in Technical Writing on 4/13/2022

Technical Writing Manager: Definition, Responsibilities, Job Description

Technical Writing Manager: Definition, Responsibilities, Job Description

Technical writers supporting your business may be high-caliber professionals, but without due supervision and management they will remain just a group of authors each working separately. To make the team really co-operative, a new position, that of a technical writing manager, has to be introduced. What Is a Technical Writing Manager? This is actually a…

Continue reading »
Posted in Technical Writing on 4/6/2022

White Paper: How to Write It and What Is It For?

White Paper: How to Write It and What Is It For?

Imagine a business with a complex product or, rather, a program, a system, or an idea which is hard to grasp at once. The target audience will need time to understand all the details, and it will take marketers quite long to persuade the potential clients to switch to a new product. A white paper…

Continue reading »
Posted in Technical Writing on 3/30/2022

Quick Start Guide: What Is It and How to Write a QSG, Examples?

Quick Start Guide: What Is It and How to Write a QSG, Examples?

Practice shows that no matter what the product is, its users generally fall into two categories: those who want to get a profound knowledge of the product before using it and those who wish first to start using the product and then learn all the details. People from the first category prefer to carefully read…

Continue reading »
Posted in Technical Writing on 3/23/2022

Content Strategist Job Description: Responsibilities, Skills, Career Path

Content Strategist Job Description: Responsibilities, Skills, Career Path

A significant increase in customers’ demands, business activities, and permanent cooperation between different spheres of social life leads to a necessity of providing more and more content of any kind: from educational to entertaining and promotional. Companies worldwide deal with the challenge of producing and updating relevant content for different types of audiences to successfully…

Continue reading »
Posted in Technical Communication on 3/16/2022

Good and Bad Technical Documentation Examples

Good and Bad Technical Documentation Examples

Are your user manuals good or bad? Let’s run them through our quick checklist. Don’t get discouraged if it turns out to be not perfect, this article contains a lot of ideas to follow that can change your software documentation for the better! Data Completeness and Accuracy Bad user manuals make customers feel frustrated and…

Continue reading »
Posted in Technical Writing on 3/11/2022

Popular Documentation Myths Busted with ClickHelp

Popular Documentation Myths Busted with ClickHelp

Conferences for technical communicators are essential to increasing your expertise in the field, learning something new, and networking. That is true for the MEGAComm 2022 conference that took place at the beginning of February. It was a global event for tech comm-related experts who wanted to be in the loop with the latest in the…

Continue reading »
Posted in ClickHelp News on 3/10/2022