Writing and Editing Articles

Stale Articles

Mark articles as stale so your team knows exactly what needs updating even if they don’t have all the information they need right then.

author avatar
3 docs by 1 team member

Text Editor

Learn how to get the most out of our custom text editor to create new articles that help customers or your team.

author avatar author avatar author avatar
17 docs by 3 team members

​Featuring an Article

Featuring is a great way to promote your best and most important articles in HelpDocs. Here's how to make an article the star of the show. ⭐

Jake Peters
Updated 1 day ago by Jake Peters

​Creating a Subcategory

We've built a ton of knowledge bases for ourselves and others and in our extensive experience you can usually get by with just one level of categories. Though sometimes you might want to add a few more.

Jake Peters
Updated 1 day ago by Jake Peters

Hidden Categories

When you create a category for the first time, you might not see it on your customer-facing knowledge base. That's because we only display categories that contain published articles. 🙃

Jake Peters
Updated 1 day ago by Jake Peters

Understanding Search Results

We're constantly improving our search algorithm to get you the best results, but it's not always enough. If you want to improve your search, there's a couple things you can do. 🔎

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Linking to a Part of an Article

Sometimes you'll want to send your customers to a specific part of an article. Here's how.

Jake Peters
Updated 1 day ago by Jake Peters

Getting Started with Taxonomy

We don't support having the same article in multiple categories as it can create a frustrating user experience. The exception is nested categories.

Matt Aunger
Updated 1 day ago by Matt Aunger

Editing Images

If you enjoy finding the sweet spot for your images, we've got you covered. Change image size and the alignment, send folks to a different page, or be more inclusive by adding alt text.

Updated 1 day ago

Bulk Select & Edit Multiple Articles

Sometimes you want to update multiple articles at once without going in and out of each one. With bulk edit inside the content view, you can. Go forth and update. 🧙‍♂️

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Filtering Articles

Need to narrow down the list of articles with certain attributes? You can filter your articles to find what you're looking for. 🔍

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Restoring Deleted Articles

Sometimes when you're in the zone you can get a little trigger happy, we get it. If you've deleted your article recently by accident I've got good news—you can restore it. 🥳

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Previewing Unpublished Articles

We all want our docs to look just right. If you're writing or editing an article and you want to check how it looks on your HelpDocs before publishing it, you can preview it from the article editor. 👀

Jarratt Isted
Updated 1 day ago by Jarratt Isted

What is Readability?

In the article editor you'll see a readability score. This is a measure of how complex your article is to understand. 1 is super easy to understand, whereas 14 is very difficult.

Jake Peters
Updated 1 day ago by Jake Peters

Adding a Table of Contents

If you're writing guides or long form articles you might want to add a Table of Contents (TOC). This makes it way easier for people to navigate your article. 👏

Jake Peters
Updated 1 day ago by Jake Peters

Delete a Category

Now and again there might come a point where you need to delete a category. Perhaps you've restructured your docs. Or maybe you've just created a category you don't need by mistake 🙈

Matt Aunger
Updated 1 day ago by Matt Aunger

Hiding Articles from Public Search Engines

Having your knowledge base show up in popular search engines like Google and Bing can be a great way to save your customers time and reduce support tickets. However, it's not always ideal. 🙃

Matt Aunger
Updated 1 day ago by Matt Aunger

Downloading Articles to PDF

With PDF article export you can take your knowledge base offline. We'll automatically make them readable, print friendly, and nicely formatted. 💅

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Incompatible Browser Extensions

Sometimes our article editor and your browser extensions just don't get on. 😣If you're using Grammarly, Beeline Reader, or ad blockers, read on.

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Exporting & Backing Up Your Articles

At HelpDocs we take regular backups of all your data, so you don't need to worry. That said, if you need a copy of your data for any reason, it's super easy to grab it from our API.

Jake Peters
Updated 1 day ago by Jake Peters

Collaborating on Articles with Presence

We've built real-time presence indicators into the product to help you work as a team. The days of overwriting each other's work are gone.✨

Jarratt Isted
Updated 1 day ago by Jarratt Isted

Editing Category Metadata

When you start out with HelpDocs and create a category for your articles, you can customize a few things about its URL and appearance. We call this metadata. Here's what all this metadata's about.

Jake Peters
Updated 1 day ago by Jake Peters

Get in touch