Back
to top

Technical Writing Blog

Grow your technical writing expertise with industry news, best practices, articles, product updates

The Power of Knowledge Management Portals

The Power of Knowledge Management Portals

Imagine a mid-sized company, let’s call it “CodeCrafters,” that has not yet adopted a knowledge management portal. The technical writers at CodeCrafters face a challenging and inefficient work environment typical of the pre-digital era. They rely on a disjointed system of document management, using a combination of local drives, shared folders, and email to create,…

Continue reading »
Posted in Technical Communication on 7/24/2024

Understanding the Role of Proofreaders

Understanding the Role of Proofreaders

Imagine a company that prides itself on being a fast-paced, efficient content mill. In their rush to churn out content, they have dispensed with the services of a proofreader. At first, this sounded like a brilliant cost-cutting move. But it didn’t take long to realize how much their lack of a proofreader was costing them….

Continue reading »
Posted in TechComm Career Path on 7/17/2024

12 Best Online Documentation Software and Tools for 2024

12 Best Online Documentation Software and Tools for 2024

From intuitive drag-and-drop interfaces to seamless collaboration features, the best online documentation tools of 2024 will revolutionize the way technical writers approach their craft. Whether you’re creating a simple how-to guide or diving deep into comprehensive API documentation, these tools will provide the flexibility and functionality needed to deliver exceptional results. One of the standout…

Continue reading »
Posted in Technical Writing on 7/10/2024

Skeleton Illustrations to Improve UX in Technical Documentation

Skeleton Illustrations to Improve UX in Technical Documentation

Envision a user eagerly clicking on a link to access a technical guide for a new software tool they are learning. As the page loads, instead of a skeleton screen that outlines where text and images will soon appear, they are met with a blank canvas or a spinning wheel. This absence can leave the…

Continue reading »
Posted in Documentation UX on 7/3/2024

Googling Like a Pro: A Guide for Technical Writers

Googling Like a Pro: A Guide for Technical Writers

Imagine that you are looking for reliable information in a trusty search engine. You type in your query and hit enter, expecting a treasure trove of knowledge to appear before your eyes. Instead, what you see is a digital wasteland littered with misinformation, outdated sources, and irrelevant clickbait. This blog will help you tailor your…

Continue reading »
Posted in SEO Lifehacks on 6/26/2024

Engage, Respond, Improve: Maximizing User Interaction with Comments and Feedback

Engage, Respond, Improve: Maximizing User Interaction with Comments and Feedback

Engaging with your audience is more than just sharing information; it’s about fostering conversation and building a community. In the digital age, comments and feedback serve as the lifeblood of user interaction, transforming monologues into dialogues and single narratives into rich, multi-perspective discussions. In this blog post, we’ll delve into the art of encouraging user…

Continue reading »
Posted in Documentation UX on 6/19/2024

Overcoming Obstacles in AI Corporate Integration

Overcoming Obstacles in AI Corporate Integration

Artificial Intelligence (AI) stands at the forefront of technological innovation, promising to revolutionize the way companies operate. However, the path to integrating AI is fraught with challenges that can hinder its adoption. In a LinkedIn survey we conducted not long ago, we posed a simple question to our audience: “What reasons prevent you from using…

Continue reading »
Posted in Technology on 6/13/2024

Mastering Content Reuse: Best Practices for Maximizing Your Digital Assets

Mastering Content Reuse: Best Practices for Maximizing Your Digital Assets

In the ever-changing world of digital content, the idea of content repurposing has become a strategic cornerstone for marketers, content writers, and SEO experts alike. But what exactly is content reuse? At its core, content reuse is the repurposing and redistribution of existing material across multiple platforms and media. This method eliminates the need to…

Continue reading »
Posted in Technical Writing on 6/5/2024

Webinar from ClickHelp: Top single-sourcing practices beyond content reuse

Webinar from ClickHelp: Top single-sourcing practices beyond content reuse
In the realm of technical writing, efficiency and effectiveness are paramount. However, a persistent challenge that often confronts technical writers is the daunting task of generating extensive documentation under pressing time constraints. With the demand for clear and comprehensive documentation ever on the rise, writers frequently find themselves grappling with the repetition of content. Continue reading »
Posted in ClickHelp News on 6/3/2024

ClickHelp May 2024 Release: What’s New?

ClickHelp May 2024 Release: What’s New?

The ClickHelp team is excited to announce a new update to our cloud-based documentation platform. This release delivers some great enhancements that will make your experience even better, as well as some minor improvements. At the top of the list is an upgraded version of our built-in AI assistant, AnswerGenius. With expanded knowledge and capabilities,…

Continue reading »
Posted in ClickHelp News on 5/28/2024