ScreenStepsGetting Started Onboarding GuidesEvaluating ScreenSteps--Bonus: Organize a Knowledge Base

Evaluating ScreenSteps--Bonus: Organize a Knowledge Base

4 Ways to Organize a Knowledge Base

Once your knowledge base moves beyond a few FAQs, you will quickly start wondering about how you should organize your B2B software knowledge base. Many companies still implement a very flat structure to their knowledge base - a flat structure is just a list of articles with no hierarchy to them.  

If you take the approach of a flat structure, you are really just relying on the search feature of your knowledge base since that is the only way anyone is going to find anything. A flat structure will make it very difficult for your customers to browse your knowledge base.

To make it easier for your customers and co-workers to browse your knowledge base, you can organize your documentation. The first step would be to decide on some basic groupings of articles to help organize the content for your customers.

Here are some suggested approaches (as well as mistakes to avoid).

Organize Your Knowledge Base By Role

Do you have administrative users, developers and end users that use your application? If so, then organizing your knowledge base by user role can be a good option.

Create a section for admins, developers and end users. By grouping the content in this way, you make it easier for customers to find the information they need without being bothered by the information they don't.

Organize Your Knowledge Base By Intent

Do you have different customer segments that use your product? Do they use it in very different ways?

We ran into this problem. For example, we have customers that integrate with Zendesk. Instead of creating a single integrations section, we created a separate section for each integration.

Much of the help content for each integration is similar, but that is fine. By segmenting our documentation by the intent of the customer we have seen a big decrease in confusion and support requests.

Organize Your Knowledge Base By Tasks

Does your software perform tasks that fall into logical groupings? For example, creating invoices, generating reports, and reconciling payments. Those are three separate tasks.

Those tasks could be a good way to break up your documentation.

Don't confuse this with breaking up your documentation by feature. Feature-based documentation is rarely as effective as task-based documentation. Focus on the tasks (i.e. jobs they need to do at work) your customers want to perform and create your sections based on tasks, not features.

Organize Your Knowledge Base By Goals

Do your customers have different goals or purposes for using your software? Organizing by goals can be a good option.

For example, if you were an email marketing application you might create sections such as follows:

  • Growing your subscriber list
  • Using email to sell your product
  • Using email to sell your services
  • Using email to establish yourself as a thought leader

Each section would have articles that would help your customers reach their particular goal.

Choose One to Start With

Whichever method you choose, choose one. Some organization is better than no organization. Your customers and your authors will thank you for having a clear organizational strategy.

Organizing a knowledge base in ScreenSteps

ScreenSteps Structure

See instructions below for creating a site divider:

Create site dividers

Click on the dropdown arrow

Click on New Divider

That covers the basics of the ScreenSteps structure.

Next Step >> Create Better Articles

Learn how to fill up your knowledge base with great help articles.

Click here >> Create better articles


Add your comment

E-Mail me when someone replies to this comment