See how Brightspot’s knowledge management capabilities make it easy to create, organize and update documentation with reusable content, smart automation and powerful editorial enhancements. Watch the demo to discover how features like modular snippets, anchor links and code blocks streamline knowledge sharing and keep content consistent across your site.
0:04: Welcome to a short demo of Brightspot's knowledge management capabilities.
0:09: To start, let's take a look at the Brightspot documentation site, which uses our knowledge management solution.
0:15: From the homepage, I can navigate to any number of books, which is a content type developed for our use case.
0:22: Here, you see the book’s table of contents — or chapters — on the left and its main content body on the right.
0:29: Chapters are composed of topics, another content type developed for knowledge management.
0:34: Much like an article, a topic is the building block of knowledge content.
0:39: In these topics, you'll often find step-by-step instructions.
0:42: You may notice as I navigate from topic to topic that many of these step-by-step instructions include the same language for consistency.
0:50: Take, for example, this step, which says, "Click Save."
0:54: At the time of recording this demo, this phrase is used 489 times across our documentation library.
1:01: What a pain it would be if we ever decided on a different name or convention than "Click Save."
1:07: Except for the fact that, behind the scenes, you're looking at yet another content type developed for knowledge management called the snippet—a small piece of modular content that can be reused anywhere you need it.
1:20: If something ever changes about that phrase, you only need to edit it once, and it cascades down to all instances of the snippet across your site.
1:29: Now that we've seen these content types in action, let's take a look at their models in the back end.
1:34: We'll begin once again with the book.
1:36: Let's simply fill out the fields like so, and then we'll open the preview to see how they correlate to the front end.
1:44: As you can see, the display name is the book name, as well as the name of the table of contents and the link that takes a user back to the main landing page.
1:53: The description is a subheadline, and the body field is the main content on that landing page.
1:58: We haven’t touched the chapters field yet, and that's because, again, chapters are topics — so let's create a topic now.
2:05: Because the topic is so similar to the article content type, suffice it to say that the two work the same way.
2:11: However, there are a few differences that I'll call out now.
2:15: For one, H2s are automatically treated as anchor links.
2:19: This is helpful if a topic covers a more complex concept that requires multiple sections.
2:25: Each anchor appears in the book's table of contents.
2:28: You also have the option to disable these anchor links in the advanced tab.
2:32: Next, let's take a look at our snippet content type.
2:36: Let’s recreate the snippet we saw earlier.
2:40: Now that we've created the snippet, let's go back to our topic and insert it.
2:49: While we're here, let's highlight a few of the other enhancements at our disposal, like the callout module.
2:56: Here, I can emphasize a part of the documentation and mark it as a tip, note, caution, or warning, depending on its severity.
3:05: We also have a code block module where I can select the type of code, paste it in, and then annotate it appropriately.
3:16: On the front end, a user can easily copy the code using a button that appears when hovering over the code block.
3:22: Now, let's return to our book and insert the topic we just created.
3:26: It goes into the chapters field.
3:31: From here, I can add subchapters that will be displayed beneath the chapter in an expandable menu.
3:39: So, let's review.
3:41: We created a book content type, into which we placed a topic.
3:43: Underneath the topic, we nested child topics related to that section.
3:46: Within the topic itself, we used several custom enhancements specifically designed for the knowledge management use case.
3:55: While this demo presents these concepts and content types in a simple way, remember that Brightspot’s entire documentation library is built on them.
4:03: If you have any additional questions, please reach out to Mark Hoover on the platform team.