How to Build a Customized Knowledge Base with HelpDocs

customization*

Aim: To create a customized knowledge base using HelpDocs that reflects your brand and provides a user-friendly experience for your customers.

Optimal Outcome: A fully functional and branded knowledge base that provides helpful information to your customers and enhances their overall experience with your product or service.

What do you need to start:

• A HelpDocs account

• Content for your knowledge base

• A logo and branding materials

• Knowledge of HTML and CSS (optional)

Why is this SOP Important: Creating a well-designed and user-friendly knowledge base can greatly enhance your customer support experience, reducing the number of support tickets and providing quick solutions to frequently asked questions.

When and Where to execute: This SOP can be executed anytime and anywhere, as long as you have access to your HelpDocs account and the necessary content and branding materials.

Who Should Be Doing This: The person responsible for creating and maintaining your company's knowledge base.

Step-by-Step Guide:

Set up a HelpDocs account

1. Go to https://helpdocs.io/ then click Get Started free.

2. Fill-out all required fields and click Create Account.

Upload branding assets and customize your knowledge base

1. Log in to your HelpDocs account

2. Upload your brand logo

   1. Head over to Settings > Brand

   2. Upload your logo

      1. Click on the Logo box

      2. Or drop an image onto it

   3. Hit Save Changes

3. Upload a Custom Favicon

   1. Go to Settings > Brand

   2. Find the Favicon image dropzone, and click to upload your image (or drop an image inside the frame)

   3. Your favicon file will upload to our servers

   4. HelpDocs will automatically serve this file to browsers that support it

4. Choose a Template

   1. Head to Settings > Brand

   2. Head to the Customizations section

   3. Under Template select the layout you'd like

   4. Hit Save Changes

Create your first article

1. On your dashboard, navigate to Content then click the "Create article" button.

2. Give your article a title and add your content using the built-in editor. You can also add images and videos to your articles to make them more engaging. Click Save changes once done.

3. Repeat this process as many times as you need to create more articles.

Organize your articles

As you add more articles, you may want to organize them into categories and sections. Click on "Create Category" to create new sections or categories.

Then, drag and drop articles into the appropriate section or category.

Preview and test your knowledge base

Use the "Preview" button to see how your knowledge base looks and functions. Test your articles and links to make sure they're working as expected. Make any necessary adjustments to your content or customization options.

1. In the article editor make sure you've saved your latest changes.

2. Hit the Preview button in the upper right-hand corner of the article editor.

3. Done! You'll see how your article looks on your HelpDocs.

Publish your knowledge base

When you're ready, click on the "Publish" button to make your knowledge base live. You can choose to use a HelpDocs subdomain or use your own custom domain name.

Live Preview

Below is a sample of how your knowledge base can look once everything goes live. Remember, you can customize the favicon, the name of your knowledge base, the template, and the colors.

Conclusion

You’re done!

You've successfully built a customized knowledge base with HelpDocs. Keep your knowledge base up to date and make changes as needed to ensure your customers have access to the most accurate and helpful information.

Execution Checklist:

• Set up a HelpDocs account

• Upload branding assets and customize your knowledge base

• Create your first article

• Organize your articles

• Preview and test your knowledge base

• Publish your knowledge base

• Live Preview