Technical Writing Blog

You spent months building a documentation portal. Hundreds of topics, organized structure, accurate content. Then a user asks ChatGPT about your product and gets a confident, wrong answer, because the AI couldn’t read your portal at all. If AI tools can’t read your documentation, your documentation doesn’t exist for a growing share of your users….

You’re building something important: critical documentation that informs users, guides developers, or ensures compliance. Your team is collaborating, diligently crafting each section. Then the review phase arrives – and the familiar scenario unfolds: a master document in Word, a handful of reviewers, and a flurry of emails carrying attachments back and forth. Before starting the…

Ever hit that F1 key in a Windows app and see a helpful window pop up? Chances are, you’ve stumbled upon a CHM file! Think of them as little digital books, bursting with info and ready to guide you through software, explain tricky tech, or even just offer a good read. This guide is your…

Insertion of videos into your content is one of the most effective ways to engage and educate users. Whether you’re creating a user manual, a knowledge base, or a web help system, videos can explain complex processes more clearly than text alone. Inserting videos in ClickHelp is simple and flexible, allowing you to include visual…

Embedding math equations in documents enhances clarity and professionalism, particularly in academic, scientific, and technical writing. This comprehensive guide will walk you through the reasons for embedding equations, the tools available for various formats, and best practices to ensure your equations are displayed correctly. Why Embed Math Equations? (Use Cases & Benefits) Quite often, users…

As your company’s documentation continues to accumulate, you and your team may encounter issues such as losing documents stored on office PCs or instances where document owners forget to share important information with their colleagues. These challenges are common in companies that store information internally. Establishing and maintaining your company’s knowledge base can be a…

In the fast-evolving realm of technical communication, professionals are tasked with the pivotal role of translating complex information into understandable and actionable content. To shed light on this multifaceted field, we had the privilege of conversing with a seasoned tech communication specialist – Mridula Menon, senior manager and information developer at GreyOrange. She has been…

Effective teamwork is vital for the success of any project, and it is particularly important for technical writers since they have to collaborate closely with developers, subject matter experts, and others to produce high-quality documentation. The combined efforts of the whole team help them see the big picture and achieve results that far surpasses almost…

In today’s digital age, product documentation has become an essential component of a successful business. However, it’s not just about having clear and concise documentation for your customers. It’s also about creating a seamless experience for them when accessing this information. That’s where branding comes into play. In this article, we will explore the importance…

If you are an API technical writer, chances are you have heard of Swagger. In this blog, we will explain the main tools that Swagger offers, the advantages of this powerful platform, and ways to connect your API documentation created in Swagger with your user manuals. What Is Swagger? Swagger is a set of open-source…