Technical Writing Blog

If you are facing a situation when multiple employees are constantly asking the same questions or needing guidance on the same topics, and new employees require a significant amount of time and resources for onboarding and training, it may indicate a lack of easily accessible information within the company. In such cases, a knowledge base…

Continue reading »

Knowledge base software is an important tool that helps to make the company’s documentation accessible and reusable. With a knowledge management system, your company’s documentation becomes a valuable asset rather than just an information silo. Continue reading »

Selecting a Component Content Management System (CCMS) is a crucial choice that will affect the operations of content administration, management, and publishing processes. The key factor to consider when choosing a CCMS is the capabilities of the system. Continue reading »

It may be difficult to believe, but not so long ago content used to be created without using Component Content Management Systems (CCMS). This presented certain challenges for technical writers, challenges that we have all but forgotten today. For example, inconsistencies, redundancies, and inefficiencies in the content production workflow due to poor version control and…

Continue reading »

In recent years, there has been a significant transition of educational technologies to an online format. This shift has led to the widespread adoption of various digital tools and platforms aimed at facilitating remote learning. Consequently, we are currently witnessing the emergence of novel educational formats, including virtual classrooms (such as Zoom, Google Meet, and…

Continue reading »

In the course of creating technical content, many writers encounter the challenge of determining how sophisticated or simple their language should be. Though it might seem like an odd question, it is a genuine dilemma. If you choose overly complex language or jargon, the technical documents you create can be difficult for the reader to…

Continue reading »

Technical documents without tables appear less organized and can be harder to follow for readers. Tables make complex information easier to understand and digest by presenting it in a visually appealing and structured format. Without tables, important data may appear cluttered or disorganized, making it more difficult for readers to grasp the content efficiently. Tables…

Continue reading »

Diataxis calls itself a “systematic approach to technical documentation authoring.” In a nutshell, it’s a framework for building your documentation. It puts the needs of the reader—the person we’re writing our documentation for—as a priority and the cornerstone of documentation creation. In the center of the Diataxis are four distinct user needs and four documentation…

Continue reading »

To create clear, consistent, and professional documentation, a technical writer needs not only a good understanding of the end user’s needs and a certain talent for writing but also specialized tools. With the right software, it’s much easier to focus on delivering clear and concise content since a lot of other tasks and processes are…

Continue reading »

Imaginative writing and technical writing are two completely different forms of writing, each requiring different skills and approaches. Imaginative writing is another term for fiction writing and means the creation of imaginative, fictional stories that can take the form of novels, short stories, plays, etc. It involves the use of literary devices, such as character…

Continue reading »