Logging In To Your HelpDocs
Understanding Smart 404 Pages
Setting Up a Custom Domain
The HelpDocs Trial
Adding or Changing Your Profile Image
Setting the URL Style for your Articles
Switching Between Multiple Accounts
Understanding Top Articles
Writing and Editing Articles
Using Quote Blocks
Using Markdown Blocks
Embedding Audio Files
Using Code Blocks
Adding an HTML Block
Getting Started with Content Blocks
Using Ordered Lists
Switching the Editor Mode
Adding Tags to Articles
Moving an Article to a Different Category
Text Editor Shortcuts
Understanding Article Statuses
Article Backups, Revisions, and Versioning
Inserting Images into Ordered Lists
Adding Note, Tip, and Warning Callouts
Featuring an Article
Downloading Articles to PDF
Restoring Deleted Articles
Creating Draft Versions of Published Articles with Working Copy
Exporting & Backing Up Your Articles
Getting Started with Taxonomy
Previewing Unpublished Articles
Adding a Table of Contents
Creating a Subcategory
Understanding Search Results
Linking to a Part of an Article
Bulk Select & Edit Multiple Articles
What is Readability?
Delete a Category
Hiding Articles from Public Search Engines
Incompatible Browser Extensions
Collaborating on Articles with Presence
Editing Category Metadata
Setting Up Integrations
Available Commands in Your Slack Workspace
Get Feedback, Activity, and Contact Form Notifications in Slack
Sharing Articles From HelpDocs to Slack
Configuring Your Slack Integration
Installing the Slack Integration
Using HelpDocs with Ticketing Systems
Adding a Feedier Carrier
Connecting Google Analytics
Syncing Content to elevio
Connecting Gainsight PX
Enabling Comments with Disqus
Customizing your HelpDocs
Getting Help with Code Snippets
Customizing Feedback Icons
How to Change the Logo Link
Add HTML Before the Closing Body Tag
Overriding the Font on Your Knowledge Base
Using Different List Styles
Disabling Authorship and Updated Times
Using HelpDocs with RTL Languages
Disabling Related Articles
Making Your Printed HelpDocs Look Nicer
Making Video Embeds Responsive
Adding Lightboxes to Images
Disabling Top Articles
Making Tables Scroll When They're Too Wide for the Page
Using a Background Image in the Header
How to Add Extra Spacing
Custom HTML Templates
Customizing an Article Slug, Meta Description & Short Version
Adding Icons to Categories
Featuring a Category
Adding Custom CSS
Understanding the Contact Form
Uploading Your Brand Logo
Setting a Custom Favicon
Setting Category Display Order
Setting Article Display Order
Hosting HelpDocs at a Subfolder of Your Site
Adding an Open Graph Fallback Image
Adding URL Redirects
Changing the Language in Common Phrases
Choosing a Template
Hiding the Contact Button
Adding Custom Navigation Links
Automatically Translate Articles with Machine Translations
Setting Up Multilingual Docs
Translating Your Docs
Assigning Default Permission Groups to Categories
Creating and Managing Permission Groups
Getting Started with Permissioning
Assigning Permission Groups to Articles
Removing Permission Groups from Articles
Restricting Your Docs to Logged In Users
Shared Password Protection
Restricting Your Docs by IP
Configuring Slack Single Sign On
Accessing User Data in HelpDocs
Using OpenID Connect for Single Sign On
Setting Up and Using SAML Single Sign-On
Restricting your HelpDocs with Custom JWT SSO
Data & Analytics
Getting Team Event History with Audit Trail
Search Click Analytics
Exporting Your Stats
What is the Happiness Score?
What are Tickets Avoided?
Lighthouse Widget API
Adding Lighthouse Trigger Buttons to Webflow
Cancelling Your Account
Tax Residency Certificates and Forms
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Updating Your Billing Information
Changing Your Plan
European Union VAT Charges
Can I migrate or import my data from another service?
One of my headings isn't showing in the table of contents
I’m seeing a blank screen when I load my knowledge base
I've added a script but it isn't working
Can I change the HelpDocs branding?
Can I use multiple HelpDocs accounts together?
Who counts towards the user limit on plans?
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 can't log into my HelpDocs account
What is an account slug?
Can I host my API docs in HelpDocs?
My article has a blank space to the left of it. What's wrong?
How do related articles work?
Can I host my internal docs in HelpDocs?
Is HelpDocs GDPR compliant?
How do I change my email?
Will translated articles be deleted if I remove that language?
Finding CSS Selectors in Your Browser
Optimizing Your Knowledge Base for Search
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Writing Clear and Digestible Knowledge Base Articles
Table of Contents
Updated by Jarratt Isted
It's great making the first step towards help users with your product, but knowing what to write when you've got a blank knowledge base can make it difficult to make progress.
In this guide, I'll give you some examples so you can start helping users right away.
The categories you create will depend wildly on what your product is and what it does. Luckily there's major similarities in all businesses:
- All customers are new at some point
- A team will answer customer questions
- Businesses charge money for services
So whether you sell car wash liquid or language subscription software, the following three categories should help. Feel free to create these in HelpDocs, including the descriptions.
Helping new users get up to speed with how your product works so they're more successful.
New around here? Let us get you up to speed with how everything works.
A place for your customer service/success reps to put answers to questions that don't find anywhere else.
Read answers about the things customers ask us through support.
Users will find it easier once they know your payment policies, like how you handle cancelling and refunds.
Learn how we handle billing, cancellations, and plan related queries.
These articles will depend on what industry your company is in, but they should be enough to help you start scaling your support with self-service help. Just copy, paste, and adjust.
Subscribing to a plan
It's fantastic to hear you're looking to subscribe—we can't wait to welcome you as a customer. It doesn't take long to start your subscription.
Note: You'll need to be an administrator to subscribe to a card.
Subscribing to a plan
[Enter instructions here about how customers subscribe to any of your plans.]
How we take payments
We use [Provider] to process payments. You can read about how they secure your data over here: [LINK].
How we handle cancellations
First off, we're sorry to see you go. If you've got some time we'd love to hear whether we missed the mark somewhere.
You can cancel your subscription by [INSTRUCTIONS].
It usually takes us [TIMEFRAME] to get everything cancelled. After cancelling, you'll no longer be able to [FEATURES] so you may want to export your data beforehand.
Exporting your data
Whether you're taking the data to a meeting or moving platforms, we've made it easy to export your data. We provide your data in [FILE FORMAT(S)].
Creating useful documentation for users is going to take some time. Getting into the habit of writing new content when questions are asked and then answered by your team can reduce the time to making it successful.
To make this process a little easier, here are integrations we've made that allow you to create articles directly inside their software: