Technical Writing Blog

Documentation plan is a planning document used to outline a strategy for generating, managing, and distributing documentation for an organization or project. It serves as a roadmap to ensure that all necessary content is created, structured, and made accessible to stakeholders. A well-structured documentation plan is valuable as it facilitates communication, ensures consistency, and provides…

We’re not asking why you want to move your documentation from Confluence to ClickHelp.  We’re just telling you how to do it. Before You Begin Make sure you have the following: Starting the Import Note: In ClickHelp, a Project serves as the equivalent of a Confluence Space. Selecting Your Confluence Edition The Confluence Login step…

PDFs are the gold standard for sharing professional documents. They preserve formatting, work on any device, and are easy to secure. Whether you’re creating user guides, training materials, or technical documentation, a PDF manual ensures your content looks polished and is accessible offline. Key reasons to choose PDFs: How to Create a PDF in ClickHelp…

Ever wondered why some texts feel effortlessly clear while others leave you scrambling for a dictionary?  The secret often lies in readability—and formulas like the Flesch Reading Ease Formula are the keys to unlocking it.  In this guide, we’ll break down how these formulas work, why they matter, and how to use them to connect…

Ever feel like you’re writing into a void? You’ve poured hours into crafting your docs but somehow something just doesn’t click with users? Well, maybe this something is a problem with readability. Meet the Coleman-Liau Index. Let’s take a look into this readability compass and see how it can sharpen your content’s impact. What Is…

The presentation of your documentation matters just as much as its content. An image instead of a plain white background is just another way to reinforce your brand identity, enhance readability, and create a cohesive look across reports, letterheads, or marketing materials. The best part? You don’t need advanced design skills to achieve this. Just…

Importing PDFs into documentation should be easy—but most tools make it anything but. We tested 30 different solutions on the market, and the results? Inconsistent formatting, broken tables, missing lists, and hours wasted on cleanup. That’s why we built our own native PDF import, designed to work as well as the best solutions out there—but…

Ever wondered why a sheet of A4 paper fits perfectly in folders, printers, and hands worldwide? This unassuming rectangle is a marvel of design, rooted in mathematical precision and international standardization. Let’s explore why A4’s dimensions make it a universal favorite for offices, artists, and everyone in between. A4 Paper Dimensions: The International Standard The…

Suppose you are the manager of a software development team in a technology startup that is developing an innovative, cloud-based CRM system. The release date for the software is approaching, and as the manager, it is your responsibility to update the team on project statuses. You will inform them of potential risks and the steps…

Now more than ever, clarity and readability in writing are essential. One of the most widely used methods for assessing the difficulty of written material is the Gunning Fog Index. This index produces a number that represents the years of schooling a person would need to read and understand your work. In other words, the…