Technical Writing Blog

As your business grows, your company knowledge base expands. Documents tend to accumulate on the employees’ PCs, usually connected by intranet. This is an internal document management system allowing for storing and sharing information. The information is generally structured. Every employee can see the structure in the file manager. It is presented in folders usually…

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…

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…

The present-day virtual reality is a dynamic world whose borders are expanding daily. Its basic features are growth and integration. Growth means more and more software, websites, platforms, and resources. These elements are not isolated. They are involved in the process of constant integration. Integration implies the existence of features that are identical or, at…