Understanding Smart 404 Pages
The HelpDocs Trial
Logging In To Your HelpDocs
Setting Up a Custom Domain
Adding or Changing Your Profile Image
Understanding Top Articles
Switching Between Multiple Accounts
Setting the URL Style for your Articles
Writing and Editing Articles
Adding a HTML Block
Using Code Blocks
Embedding Audio Files
Using Markdown Blocks
Getting Started with Content Blocks
Using Quote Blocks
Using Ordered Lists
Adding Info, Tip and Warning Callouts
Inserting Images into Ordered Lists
Article Backups, Revisions and Versioning
Adding Tags to Articles
Understanding Article Statuses
Switching the Editor Mode
Text Editor Shortcuts
Moving an Article to a Different Category
Delete a Category
Featuring an Article
Adding a Table of Contents
What is Readability?
Creating a Subcategory
Downloading Articles to PDF
Previewing Unpublished Articles
Restoring Deleted Articles
Bulk Select & Edit Multiple Articles
Collaborating on Articles with Presence
Getting Started with Taxonomy
Linking to a Part of an Article
Hiding Articles from Public Search Engines
Exporting & Backing Up Your Articles
Understanding Search Results
Incompatible Browser Extensions
How to Add Extra Spacing
Setting Up Integrations
Sharing Articles From HelpDocs to Slack
Available Commands in Your Slack Workspace
Installing the Slack Integration
Configuring your Slack Integration
Get Feedback, Activity, and Contact Form Notifications in Slack
Enabling Comments with Disqus
Connecting Gainsight PX
Using HelpDocs with Ticketing Systems
Syncing Content to elevio
Adding a Feedier Carrier
Connecting Google Analytics
Customizing your HelpDocs
How to Change the Logo Link
Using a Background Image in the Header
Disabling Related Articles
Disabling Authorship and Updated Times
Disabling Top Articles
Using HelpDocs with RTL Languages
Add HTML Before the Closing Body Tag
Customizing Feedback Icons
Making Video Embeds Responsive
Using Different List Styles
Overriding the Font on Your Knowledge Base
Adding Lightboxes to Images
Making Tables Scroll When They're Too Wide for the Page
Getting Help with Code Snippets
Making your printed HelpDocs look nicer
Custom HTML Templates
Choosing a Template
Hiding the Contact Button
Setting Category Display Order
Featuring a Category
Setting Article Display Order
Adding Icons to Categories
Customizing an Article Slug, Meta Description & Short Version
Uploading Your Brand Logo
Understanding the Contact Form
Adding Custom CSS
Setting a Custom Favicon
Adding Custom Navigation Links
Adding URL Redirects
Adding an Open Graph Fallback Image
Changing the Language in Common Phrases
Hosting HelpDocs at a Subfolder of Your Site
Setting Up Multilingual Docs
Translating Your Docs
Automatically Translate Articles with Machine Translations
Removing Permission Groups from Articles
Assigning Permission Groups to Articles
Creating and Managing Permission Groups
Getting Started with Permissioning
Restricting your HelpDocs with Custom JWT SSO
Restricting Your Docs to Logged In Users
Accessing User Data in HelpDocs
Shared Password Protection
Setting Up and Using SAML Single Sign-On
Using OpenID Connect for Single Sign On
Restricting Your Docs by IP
Configuring Slack Single Sign On
Data & Analytics
Search Click Analytics
Exporting Your Stats
What is the Happiness Score?
What are Tickets Avoided?
Getting Team Event History with Audit Trail
Updating Your Billing Information
European Union VAT Charges
Changing Your Plan
Cancelling Your Account
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Is my data secure and protected?
Can I embed files into HelpDocs?
How do I reset my password?
Help! My app's not loading 😭
Help! No articles are appearing on my knowledge base
I’m seeing a blank screen when I load my knowledge base
I can't log into my HelpDocs account
I've added a script but it isn't working
What is an account slug?
Can I host my API docs in HelpDocs?
Can I use multiple HelpDocs accounts together?
My article has a blank space to the left of it. What's wrong?
How do related articles work?
Can I change the HelpDocs branding?
Can I host my internal docs in HelpDocs?
Who counts towards the user limit on plans?
Is HelpDocs GDPR compliant?
How do I change my email?
Can I migrate or import my data from another service?
Will translated articles be deleted if I remove that language?
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Writing Clear and Digestible Knowledge Base Articles
Finding CSS Selectors in Your Browser
Optimizing Your Knowledge Base for Search
Updated by Jarratt Isted
Getting users to read text is a difficult problem. There's a fine line between an article helping a user become successful or a user finding themselves more confused than they were before.
Here are some tips on writing your articles with users in mind.
Keep articles short and readable
When a user visits your knowledge base they're looking to skim content and find an answer. It's unlikely they will read the whole article, word by word.
With this in mind, keeping articles short and to the point makes sense.
- Aim for < 500 words per article
- Use bulleted lists and/or ordered lists to break up information
- Use categories and subcategories to split up articles
- Keep paragraphs shorter than two sentences
- Use callouts to highlight important or useful information
- Insert images to illustrate a point or add an example
- Longer articles should provide a table of contents for easy navigation
- Use tables for complex information
The structure your article
An article can quickly become out of control if you're not sure what to write. If a user knows what to expect from your format of your articles, it'll be easier for them to read the next when a problem arises.
If you're unsure, here's a simple example of how to write out your articles.
- Introduction. A short snippet about what the article solves for the user.
- What will the article help me with?
- Do I need to know anything before I get started?
- Instructions. An ordered list with step by step instructions on what actions the user needs to take.