Introducing Docs

How to create a knowledge base

By Stefan Dreßler
April 2, 2020

In the digital age, every project requires some form of documentation to provide and share essential information with both customers and colleagues. With HelpSpace Docs, you can create knowledge bases for your solutions and products. You also have different layout styles to fit various needs and scenarios.

Website Styles

We offer three modern website styles:

  1. Help-Center: The classic knowledge base, e.g.,
    https://supportcenter.helpspace.com/

  2. Documentation: Ideal for structured pages or API documentation, like our technical documentation, e.g.,
    https://documentation.helpspace.com/

  3. Blog: Perfect for keeping your audience up to date, like our Blog.
    https://blog.helpspace.com/

Each style can be customized to match your corporate design.

Domain

Each site receives its subdomain. You can use a subdomain such as your-product.helpspace-docs.io or a custom domain like docs.your-domain.com.

For each custom domain, you need to configure the DNS settings with your DNS provider.

Visibility

To make a site visible to your customers, toggle the visibility switch in the settings. By default, new sites are not visible and are behind a login screen.

Bildschirmfoto-2020-03-03-um-01.45.29.png

Additionally, you can set whether an article is visible or specify when it becomes visible to everyone.

Website Branding

Customizing your site to fit your brand identity is simple. You can easily change the logo and colors within the site settings.

Writing Articles

Our goal is to provide a highly productive and high-quality writing experience. The editor is minimalist and features a “focus mode” Bildschirmfoto-2020-03-03-um-00.23.16.png that brings the editor to the forefront.

The toolbar offers a variety of options for formatting and styling your content, including:

  • Formatting text

  • Adding images

  • Embedding videos, iFrames, or HTML

  • Creating tables

  • Linking to other Docs articles

toolbar

Tags

Add tags to your articles to enable users to filter categories by specific tags.

Sorting Content

Click the sort mode button to reveal drag handles behind each article and category, making it easy to organize your content. The button is located below the articles.

docs-sort-mode.png

Mobile Performance

We prioritize fast performance on both desktop and mobile devices to ensure a seamless experience.

docs-page-speed-optimized.png

Reader Mode

HelpSpace Docs supports reader mode for all major browsers.

Was this article helpful?

Thanks for your feedback!