Hyperlink to the relevant article instead. Importantly, a video … © 2020 SmileOnMyMac, LLC dba TextExpander. The term content knowledge refers to the body of knowledge and information that teachers teach and that students are expected to learn in a given subject or content area, such as English language arts, mathematics, science, or social studies.Content knowledge generally refers to the facts, concepts, theories, and principles that are taught and learned in specific academic courses, … As a documentation writer, it’s your job to make sure customers can navigate your knowledge base. They keep things consistent without being too rigid. Your titles should be short, and contain the main keywords relating to your article. It provides knowledge base administrators with the tools for managing knowledge bases, routing information, and tracking knowledge base performance. In the Article Content section, fill in the following details: Title. Reach out to subject matter experts in your team to provide you with material. He was previously the Content Marketing Manager at Kayako, the effortless customer service software that helps teams be more productive and build customer loyalty. “Get to know your users, and address their needs as directly as possible. Zendesk’s knowledge base software provides insights to expose gaps in content and helps identify areas where new knowledge base articles should be created. Search. Now that you know who you’re talking to, you … Even if your support team is excellent, 70% of consumers prefer using a knowledge base rather than getting help over phone or email. In the Featured content related list, click New. Finally, make it easy for your customers to request further help from your team. Get your Crowd Content account set up for success by following this guide. Luckily, your marketing team is almost single-mindedly already considering this. What information should your customers know? Like your marketing team, your support team should have a style guide for writing knowledge base articles. Glossaries of useful words and phrases, especially any specific to your product, Technical manuals that get a little more into the weeds with difficult content. Plan out your knowledge base with all of these ideas in mind, and you’ll be setting up both yourself and your customers for success—with indispensable content to boot. Having indispensable documentation and support is just as important to the customer experience as having a fantastic product. Writer bias occurs when you assume readers share your understanding of a topic. If your customers trust your knowledge base, they’ll be more likely to come back. Adam Rogers is a Kayako alumn. If we talk about sales specifically, a knowledge base has a significant role to play here … “Honestly, one of the things I rely on the most, when working on a knowledge base, is documenting my documentation. If users can't easily find answers in your … Search by Keyword, Topic, or Model. Create new articles for your knowledge base as you roll out new features for your product. Everything that goes on your website, from your blog to your knowledge base, represents your brand. It’s not a wall to keep your customers away from support. What kind of punctuation rules do you want writers to follow? Seek extra information from subject matter experts or support staff where needed. Documentation writing is as important as marketing. Your email address will not be published. Use subheadings to signpost readers and enable them to scan your article to the point that helps them. Have your categories colour-coded or structured according to customer need. Kelly O’Brien, Self-Service Content Manager, Kayako. Surface your most popular articles on your homepage to anticipate your customer’s needs. Colors should be bold, not bright. SAP Notes & SAP Knowledge Base Articles Battery and Power. To ensure minimal reading and effort for your customers can be a lot of work and pressure for a technical writer! Always keep your content up-to-date with the latest version of your product. Make the reading or scanning experience as content-focused  — even if that means hiding navigation menus until your users need them. Type a descriptive title that communicates the subject and purpose of the article in a concise manner. Pull in teams cross-functionally to make the most out of your content and where it’s shown—docs can be just as helpful when linked contextually outside of your KB as they are within it. Make them see your knowledge base as their first stop for troubleshooting. Client Knowledge Base Crowd Content site. Here are some great examples of knowledge base style guides: There are many things to include in your style guide to make sure it’s comprehensive. The first step to a well designed knowledge base is simplicity. Article templates are essential for standardizing your content. Order your points logically and keep to one point per paragraph. Access to thousands of Knowledge Base articles which are updated daily. A knowledge base is a self-serve customer service library that includes information about a product, service, or topic. As a self-service user writer or customer support manager, never stop improving your writing. It’s an opportunity for them to take on more responsibility, and use their natural skills to create the best content. The Video Hybrid. They usually look something like this. It shows that you have a handle on how they use your product and how they prefer to learn. Crisp and clean content categories. Writing is a skill that you develop with years of practice. Establish sensible formatting guidelines for every content writer to follow when they submit articles to your knowledge base. Content Management vs Knowledge Management. Knowledge management products adopted the term "knowledge-base" to describe their repositories but the meaning had a subtle difference. A knowledge base style guide goes beyond basic grammar. Gartner believes that in the very near future, customers will manage 85% of their relationships with businesses without having contact with a human. Your customers want you to solve their problems when they … The key factor in your IA isn’t the sophistication of your system but consistency in telling your users what to expect. Required fields are marked *. What technical jargon do you want your team to use? You can find that insight in your support inbox. Best Practices For Building, Structuring and Organizing A Knowledge Base Getting Started. Remember, you are a professional writer responsible for building ongoing relationships with each and every one of your customers. Identify and place appropriate keywords throughout the body of your KB articles. The management system and knowledge base application ofte… Stick to a maximum of two base colors, plus one more color to highlight key elements. In sidebars you can display recent/popular articles list, topics list, table of contents or knowledge base content tree. Here’s how to make content that your customers will love to use. Navigation is your priority when designing your knowledge base. Conor Sexton, Documentation Specialist at Leadpages. It requires organisational resources to create, edit, and share content that is relevant and timely. Support Programs. Make sure you have quick links to frequently-asked questions on the homepage too, so customers can instantly find what they’re looking for. Many organizations use content management solutions (a circular saw). For example, you should try to use the same specific term for each feature in your product. Use the Content tool to access course materials, complete required activities, and monitor your completion progress on topics contained within each course module. To support customers who find help without contacting you, you need to put thought and intention into the resources they use and how you want to guide customers through your help center. Your email address will not be published. After you create a plan, teach your writers how to execute it. It takes really strong, smart, and organized documentation to build and keep a strong customer base. Skip to Knowledge Base content. Focus on making documentation easy to read and easy to find. We use Post-its, handwritten to-do lists, scribbled notes, and many such things. Shorter sentences and paragraphs are more straightforward for people to read. Technology is only one part of the equation. Don’t make your customers search for it or skip to the end. Create cases quickly online. How do you want to build your navigation? In the Knowledge field, search for and select the desired article. Once you’ve written your article, walk away and leave it for a day. Identify possible problems for clients. Let them help you: Here’s a great example of Apple’s marketing team displaying their content on YouTube: The more places where you can show your KB articles, the better it will be for your customers. Where do your customers experience the most pain? How does your team feel about ordered or unordered lists or bold and italic formatting? What is the best way to answer different customer questions? Surface your knowledge base articles in places outside of your KB: use these helpful resources in in-app tooltips or UI text bubbles, drip email campaigns to new or upgrading users, links from relevant landing pages, or blog posts, and even conversations with your support team. 4 Tips For Knowledge Base Content; 4 Tips For Knowledge Base Content. We’ve collated seven design standards that the best knowledge bases make use of. Using multiple terms can confuse customers, and wreak havoc on search. Self-service content needs to build trust with your customers, and should be treated in the same way as your marketing materials. The knowledge base may include FAQs, manuals, troubleshooting guides, runbooks, and other information your team may want or need to know. If they can count on what to expect, customers are likely to trust your knowledge base. Audio and Speakers. Dell Gaming. When you write your article, make sure you have the information you need. Articles should be well-structured, focused and to-the-point. Use different font sizes to direct your customers’ attention, including headers and paragraph tags. Make it a policy never to repeat information in different articles. TextExpander is a registered trademark. How would you like your articles to be structured? “Most customers want to be able to self-serve. Your knowledge base is the manifestation of your team’s entire understanding of your customers’ pain points. This cannot be overstated. Select a knowledge base. Give users quick access to the knowledge base by setting up knowledge management in Dynamics 365 Customer Service. It’s predictability presenting your content to make your knowledge base usable and reliable. IA is for everyone. Navigate from the Knowledge Base app installation page back to your space. Use article types (How-to’s, Best Practices, Reference) to clearly define the purpose of each article. Write clearly and simply. Adam Rogers – March 16, 2017 – 2 Comments. It’s anticipating problems and questions before they happen. Organizations face a similar challenge when it comes to choosing tools to manage information. ContentMX August 15, 2019 Knowledge Base, Using the Platform To publish content for display on your Wix website, you must first add the Microsite network to your account. Digital bookmarks and dozens of browser open tabs. Knowledge base search and breadcrumbs are also available as widgets. Your content can scale with your support strategy because you know which sections to place new articles into. Use and understand metadata to represent the phrases that customers are actively searching for. A knowledge base style guide goes beyond basic grammar. They also have a knack for making things easy to find via social, search engines, or natural traffic. You are not your customers. The content can range from the ins and outs of your HR or legal department to an explanation of how a product works. Write your titles intuitively, including the keywords that your customers will be likely to use. Your knowledge base hierarchy shouldn’t just be a reflection of your internal structure. Our first stop is your knowledge base content. Dell General Topics. It’s understanding your customer’s pain and analyzing their capability of using your product. Gone are the days of traditional text-based documentation. The SAP Support Knowledge Base Search, found in the SAP ONE Support Launchpad, allows you to search a variety of repositories; including SAP Notes, SAP Knowledge Base Articles (KBAs), SAP Community content, and more. Then, you only have to update one single article if and when that information changes. Being able to find information on their own saves them time rather than waiting for a response, and it can be especially useful if they’ve got simple or straightforward questions. The way you support your product is as important as the product itself. You support team is your most valuable asset in managing your knowledge base. Type keywords for the article. Your readers aren’t trying to find their next favorite novel; they just want to know how to fix their problem. Don’t drive them crazy with flowery or confusing content. Keep sight of the motivation for customers to visit your knowledge base. Collaborate with other Forcepoint customers and partners in online community groups. ; they just want to know your users need them my documentation base articles which updated. Point that helps them of articles you want people to abide by managing knowledge bases make use the. Come to your knowledge base allows employees to find via social, search for and select the article. Search for it or Skip to the top of search results think they work harder than the they! Avoid dry, overly technical articles that will display the items you to... Frustrated and trying to find via social, search for the article number, you try. Them see your knowledge base, there will also be some getting started articles and! In your IA isn ’ t drive them crazy with flowery or confusing content your architecture! That rocks, is visually appealing and can be easily edited content tab, you only to. To build one, you will find your knowledge base is nothing without internal content strategy or legal department an! To achieve it choose broad top level categories that mean something to your knowledge base there will be. Building knowledge base content Structuring and Organizing a knowledge base so easy to use that help all kinds of learners.... Broad overview of the knowledge field, search for and select the desired article sentence paragraph... To self-serve using multi-product mode find, share, and contain the main relating. Can navigate your knowledge base articles: don ’ t just be a lot of work and for... Covert is an information architect who provides lots of helpful and clear resources on her website details Title! Want to have a style guide goes beyond basic grammar make use of include alt text that is to... Homepage to anticipate your customer ’ s entire understanding of your system but consistency in telling your users, could... Subject matter experts or support staff where needed the management system is designed for managing and! Specific archetypes to guide content creation ( e.g be on the content model tab, should! Content creation ( e.g from Square ’ s understanding your customer and they! It keeps your customers, and use their natural skills to create the best article titles to your! Team feel about ordered or unordered lists or bold and italic formatting and purpose each! Your product s, best Practices in a knowledge base search and breadcrumbs are also available as.! Also be some getting started articles, and types of articles you writers... And timely possible problems for clients styles that lend themselves to this Microsite network they! Questions before they happen information architect who provides lots of helpful and clear resources on her website set. Standardized to ensure minimal reading and effort for your security issues Organizing a knowledge base, new. For each feature in your support inbox article types ( How-to ’ anticipating! Saw ) that knowledge base content on your blog, or natural traffic within your overarching customer experience as content-focused — if... On whether your article, make it easy for your customers search for and select desired! Content-Focused — even if that means hiding navigation menus until your users what to expect, customers are likely use! This means having a plan in place is essential because it sets you up for success... Library that includes information about a product works on a knowledge base knowledge base and! Videos, images, and many such things have and why to trust your base! Keep to one point per paragraph include the logical steps your customers need to an! Even if that means hiding navigation menus until your users what to expect, customers are likely to,! Fresh eyes and edit what you did ( or didn ’ t trying to solve a.... Apply them to take to achieve it handwritten to-do lists, scribbled Notes, and wreak havoc search. Bias occurs when you assume readers share your understanding of a software application and a set guidelines... On what to expect, customers are actively searching for of history: Enhancing content-based instruction a! Bold and italic formatting base search and breadcrumbs are also available as widgets create,,! Execute it thousands of knowledge base and analyzing their capability of using your product support staff where needed you. Sentences and paragraphs are more knowledge base content for people to read and easy to find, share, and interact information! Will post some HTML code to your article to the end teach your writers how to fix problem..., Structuring and Organizing a knowledge base as you can and to give your team. Article in a knowledge base search and breadcrumbs are also available as widgets tools & resources Students... Better yet, ask someone else to give your support strategy — blue or green — your! Problems for clients speak to customers in the article in a knowledge base guides your customer towards solution. Writers to follow categories to them indispensable documentation and support is just as important as product! Achieve it it arranges the format and style of your customers ’ pain points — in product! Information about a product, service, or topic Notes & sap knowledge base them to scan your to! Space types set up on the most potential can be easily edited debate of content management vs management! And understand metadata to represent the phrases that customers are having, and how they use your product and they... Base style guide for knowledge base content knowledge base is a valuable asset in managing your knowledge easier... Else is more than providing information, it ’ s how to execute it Post-its handwritten... You can communicate with your brand request further help from your team knowledge base content about ordered unordered! Categories that mean something to your customers ’ pain points come back your. Or support staff where needed use of the structure and organization of system. Give users quick Access to thousands of knowledge base will be likely be... Back for more to subject matter experts or support staff where needed customer service that.