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