Logging In To Your HelpDocs
Setting the URL Style for your Articles
Understanding Smart 404 Pages
The HelpDocs Trial
Adding or Changing Your Profile Image
Switching Between Multiple Accounts
Understanding Top Articles
Setting Up a Custom Domain
Writing and Editing Articles
Adding an HTML Block
Using Markdown Blocks
Embedding Audio Files
Using Code Blocks
Getting Started with Content Blocks
Using Quote Blocks
Moving an Article to a Different Category
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Switching the Editor Mode
Adding Tags to Articles
Article Backups, Revisions, and Versioning
Using Ordered Lists
Understanding Article Statuses
Text Editor Shortcuts
Using help.new to Create Articles
Linking to a Part of an Article
Understanding Search Results
Creating a Subcategory
Adding a Table of Contents
Featuring an Article
Restoring Deleted Articles
What is Readability?
Incompatible Browser Extensions
Editing Category Metadata
Exporting & Backing Up Your Articles
Collaborating on Articles with Presence
Hiding Articles from Public Search Engines
Delete a Category
Downloading Articles to PDF
Creating Draft Versions of Published Articles with Working Copy
Bulk Select & Edit Multiple Articles
Setting Up Integrations
Configuring Your Slack Integration
Sharing Articles From HelpDocs to Slack
Installing the Slack Integration
Get Feedback, Activity, and Contact Form Notifications in Slack
Available Commands in Your Slack Workspace
Connecting Sunshine Conversations
Enabling Comments with Disqus
Syncing Content to elevio
Connecting Google Analytics
Adding a Feedier Carrier
Using HelpDocs with Ticketing Systems
Connecting Gainsight PX
Customizing your HelpDocs
Making Your Printed HelpDocs Look Nicer
Customizing Feedback Icons
Add HTML Before the Closing Body Tag
Adding Lightboxes to Images
Making Tables Scroll When They're Too Wide for the Page
Using a Background Image in the Header
Disabling Related Articles
Using Different List Styles
Overriding the Font on Your Knowledge Base
Using HelpDocs with RTL Languages
Disabling Top Articles
Getting Help with Code Snippets
How to Add Extra Spacing
Condense Top Article Spacing on Bars V4
Disabling Authorship and Updated Times
How to Change the Logo Link
Making Video Embeds Responsive
Custom HTML Templates
Understanding the Contact Form
Testing Customizations with .dev
Choosing a Template
Adding an Open Graph Fallback Image
Changing the Language in Common Phrases
Customizing an Article Slug, Meta Description & Short Version
Hosting HelpDocs at a Subfolder of Your Site
Adding Icons to Categories
Featuring a Category
Adding URL Redirects
Uploading Your Brand Logo
Adding Custom CSS
Setting Category Display Order
Hiding the Contact Button
Setting a Custom Favicon
Adding Custom Navigation Links
Adding Cookie Consent
Setting Article Display Order
Understanding Multilingual Translation
Setting Up Multilingual
Automatically Translate Articles with Machine Translations
Removing Permission Groups from Articles
Assigning Permission Groups to Categories
Creating and Managing Permission Groups
Assigning Permission Groups to Articles
Getting Started with Permissioning
Setting Up and Using SAML Single Sign-On
Using OpenID Connect for Single Sign On
Accessing User Data in HelpDocs
Shared Password Protection
Configuring Slack Single Sign On
Restricting Your Docs to Logged In Users
Restricting your HelpDocs with Custom JWT SSO
Data & Analytics
Getting Team Event History with Audit Trail
Exporting Your Stats
What is the Happiness Score?
What are Tickets Avoided?
Understanding Articles Clicked
Adding Lighthouse Trigger Buttons to Webflow
Lighthouse Widget API
Integrating Lighthouse with Live Chat Providers
Tax Residency Certificates and Forms
Changing Your Plan
Subscribing to a Plan for the First Time
Cancelling Your Account
Updating Your Billing Information
European Union VAT Charges
Invoices and Email Receipts
Is my data secure and protected?
I’m seeing a blank screen when I load my knowledge base
I've added a script but it isn't working
Help! My app's not loading 😭
Can I host my internal docs in HelpDocs?
My Article Has a Blank Space to the Left. What's Wrong?
Can I Change the HelpDocs Branding?
Can I migrate or import my data from another service?
Can I host my API docs in HelpDocs?
How do related articles work?
How do I reset my password?
What is an account slug?
Help! No articles are appearing on my knowledge base
I can't log into my HelpDocs account
Will translated articles be deleted if I remove that language?
Is HelpDocs GDPR compliant?
How do I change my email?
Who counts towards the user limit on plans?
One of my headings isn't showing in the table of contents
Can I embed files into HelpDocs?
Why isn't my contact form showing up?
I'm getting 'Your connection is not private' on my custom domain
How do I publish an article that's not available in the default language?
HelpDocs Support Scope
Can I use multiple HelpDocs accounts together?
Finding CSS Selectors in Your Browser
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Optimizing Your Knowledge Base for Search
Writing Clear and Digestible Knowledge Base Articles
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.