Technical Writing Blog

Every growing company will sooner or later face the problem of creating a document management system (DMS). For this, certain steps should be made, and the first one is to decide whether it will be an on-premise or a cloud-based document management system. Looks like a simple question, but the system will have to meet…

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. When Things Got Way Too Complex It all started in the civil branch of the…

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…

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…

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…

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…

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…

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…

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…

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…