Technical Writing Blog

Document version control is a vital part of any documentation management process, where it is necessary to keep track of all changes made to the documents. It is used in various fields, such as software development or design and construction. Document version control is required in any field of technical writing, particularly in long-term projects…

The way documentation looks is not just text or visuals placed on a page. The appearance of technical information includes a complex system of features. Some time ago, documentation features were regulated by style guides available in every company. Traditionally, company style guides were based on popular stylebooks such as the Modern Language Association Handbook,…

The creation of content is an on-going process. The company’s technical writers constantly create content to support the product, incorporating new features and developments. Additionally, it is common for similar issues to be covered in different documents, as is typical for CCMSs (component content management systems). These circumstances give rise to the challenges of searchability…

These days, PDF files — short for “Portable Document Format” — are one of the most regularly used files. One can say it has almost become a usual requirement that simplifies the interaction between departments and increases the working productivity overall. There are some undeniable advantages that made PDFs such a helpful office assistant. Compatibility….

A business requirements document (BRD) is a reflection of the main idea behind a project. It describes the goals and objectives of the project and the results it is designed to achieve. No matter what field you are working in, you need a robust BRD to manage and align all the activities within the project….

Today, documentation is one of your company’s assets. It helps your customers understand how your product works or, putting it differently, enhances the usability of your product. This is why documentation should often combine seemingly opposite features. It should be both comprehensive and concise, visually appealing yet informative, neutral but also stylish (or even extravagant…

At least once in their career, most employees, both new hires and experienced ones, have faced a situation when they lack information concerning their working routine, business relations, or legal counsel (information about their rights and responsibilities). Each time this happens, employees find themselves in an information vacuum which is a fertile ground for the…

‘Reading and comprehension skills’ is a term usually associated with schooling. We often hear these words pronounced by a school teacher and applied to students. We are used to thinking these skills are relevant only at the beginner stages of education. However, ‘reading and comprehension’ is a skill we use daily, actually, every time we…

Any technical writer knows that the document creation process can be full of challenges. From using the right terminology to using the appropriate tools, there are a lot of things that can trip you up. For example, technical writing in the pharmaceutical industry is a highly specialized field with very little “creative license” with documents….

The selling process is often regarded as art, as sales depend greatly on the talent some salespeople have (and some don’t). You may call it charisma, charm, magnetism, or personal attractiveness. Whatever it is, there is something irrational in the sales process that cannot be explained. This is partly because selling is primarily based on…