But, how do you go about creating one? Knowledge - Knowledge Base & Documentation PSD Graphic Template Once again, if you already have a non-WordPress knowledge base or documentation system lined up and need a great design to use with it, this light and readable PSD is the perfect template to hand over to your developer. Read on to find out how…. In those cases, you can skip this step. Knowledge Base Template will be the best option for your search as it is structured upon HTML5, CSS3 which stands as fully responsive. Rather than answering questions or laying out steps, it tells you exactly how something works. They, too, are long, comprehensive guides that cover an entire tool or function. What's their expected difficulty level in terms of knowledge on the product or service? For example, look how we use Heroic Shortcodes to style asides in our KnowAll knowledge base theme: Readers can quickly distinguish between instructions and the additional information contained in asides. Use intelligent headings to break up your content into easily digestible chunks. Knowledge management (KM) is the process(es) used to handle and oversee all the knowledge that exists within a company. A thought-out title is essential because it’s how customers will actually find the answers to their problems.The fact of the matter is this:If your customers don’t know the knowledge base article can solve their problem, it doesn’t matter one lick how good the rest of the article is!So make your title count. You deliver more consistent customer support. How-to articles are typically brief. Choose Create > How-to or Troubleshooting and follow the prompts to create your first knowledge base article; The knowledge base space blueprint includes everything you need to get started, including article templates, and a pre-configured homepage with Livesearch and Content By Label macros. In fact, this could make your job feel even more valuable. If one article requires readers to complete two different sets of actions, it’s a good idea to stick them underneath separate headings. Push people towards the next logical step so that you ensure your customers get the most value from your product. Premium plans, Connect your favorite apps to HubSpot. Get 286 knowledge base website templates on ThemeForest. This lets readers know they’re at the right place to find answers and properly sets their expectations for what they’ll get from the article. Well done and very helpful. Check out how MailChimp does it, even on their shorter articles: And if you’ve ever used the HeroThemes knowledge base, you might’ve noticed that we do something similar with our Table of Contents widget: If you’re familiar with your product, writing instructions can be surprisingly difficult. The briefer this section is, the better, as people reading will likely be looking to get to the steps to solve their problem quickly. If needed, you can explain why a permanent solution couldn't be attained but that the solution laid out is the best case scenario for improving their situation. The pictures/images, as you say “… are worth a thousand words.” Thank you. A company's knowledge base can provide valuable information to customers, prospects, and even employees. However, the sheer length of an article could deter some readers. Then create a knowledge base article template to guide the structure. The template provides you with a basic structure using which you can quickly author content or transfer content from files and upload images & videos. Using the same template over and over allows your customers to develop cognitive fluency. There are dozens of tools to help you build a knowledge base on your site—you'll find a documentation tool in most of the best customer support apps, where you can write in rich-text, HTML, or Markdown and easily publish your documentation online. Don’t do that. You want to make sure the steps actually solve the problem they claim to solve. And then remember to use that same template for all of your knowledge base articles! ... To define the layout and static content of a knowledge document template. Create a knowledge article template. Without the link at the conclusion of the article, they might never know about that essential function in Asana. Keep your instructions simple. You can include important facts about each department, directions for product or service usage, FAQs, and original content that can provide in-depth solutions. VedhaDocs Template. Free and premium plans, Sales CRM software. Isn’t that simpler than writing: “1. That’s fine. See all integrations. You know the ins and outs, so it’s easy to forget that your readers lack the same level of expertise. All created by our Global Community of independent Web … Using the Knowledge Article Templates feature, as a knowledge administrator (a user with knowledge_admin role), you can create article templates, add or customize fields in a template, and activate or deactivate a template. FAQ articles include a list of questions about the same, related topic on a single page. Identify what the symptoms of the problem are to clearly relay what customers should be looking for. The Knowledge Base template supports a process to compose, review and publish Knowledge Base articles that are searchable by end users. Creating a killer knowledge base might not be sexy, but it will go a long way towards helping your paying customers get the most from your product. Make a comprehensive list of topics about your product or service. You can check the demo / live preview of the item from the links below. Here are a few tips to start you off on the right track: Putting time into the structure of your knowledge base articles will pay off in the form of a more easily comprehensible knowledge base. We like to solve problems on our own and feel that personal sense of accomplishment when we do. Humans are — or aspire to be — self-sufficient creatures. We highly recommend to buy kbdoc – Documentation And Knowledge Base HTML5 Template with Helpdesk Forum from the The Developer ( spider-themes ) website. [HubSpot Data]. The structure of a knowledge base article plays a major role in the piece's clarity and appeal. If you gain more information on a topic, do a keyword search to see if there are any articles with similar keywords. … Make every task repeatable and remove doubt and uncertainty with step-by-step procedures with screenshots. They're usually all listed at the top in a table of contents with anchor links that allow you to jump down the article to the specific question you need to be answered. What do I mean? Tool description articles give a short description of what a specific tool or function is. So make your title count. VedhaDocs – Documentation and Knowledge Base Template. Dedicated customers will scroll until the end when they want an in-depth, complete understanding of the problem and solution. Knowledge base Template is an HTML5 & CSS3 responsive template created for documentation for customer support for any website, plugin framework etc. When choosing titles, put yourself into the customer's shoes. Option 1: Wiki Library web part. Avoid jargon. They show you exactly what steps to take to complete a specific task or perform a certain function. So, use your knowledge base articles to drive engagement and retention. They can simply search the same question on your company's knowledge base, knowing the answer will exist in relation to the appropriate product or service. User guide articles are long, comprehensive guides that cover an entire tool or function. The data is either collected and stored through artificial intelligence or manually uploaded by expert contributors. It's evident knowledge bases are an invaluable resource to both your company and your customers. FAQ. Also, by showing your text alongside a visual, readers can follow along on their own product while reading your knowledge base and compare their progress. It’s unavoidable. To Create a new Wiki Library, click on Site Contents > Add an App > Wiki Library Avoid jargon. [Final Tips/Information to Note about the Tool]. Fully RESPONSIVE knowledge base template files Customise your catalogue presentation easily (choose theme colour, sidebar layouts, number of knowledge base articles to show etc) Super fast search, with predictive text – handy! Embed diagrams and link your articles easily with the rest of your documentation in IT Glue. Rather, it's evolving to fit the changing needs of customers. One way in which customer service has evolved is with the development of knowledge bases. Thank you! These steps can help you create knowledge base articles that are effective and clear. But when you do add extra information, make sure you format it so readers know it’s an aside. If you do not have access to create an article or service page, click the links to download the templates. You'll want to lay out steps specifically for articles that are solving problems or showing how to accomplish a task. Last but not least, you need to put these principles into developing a standardized template for your articles. It's also helpful to use search-engine-optimized keywords in the title to attract more search volume. Knowledge bases have also decreased the need for customers to search for questions on search engines. The more your readers use your knowledge base, the more they'll trust your organization as a source of accurate information. Start off the article by stating what the problem is, for scenarios that are problem-solution based. Asking for help can sometimes feel like giving up. They know that bullet icon means it’s an aside, while that other bullet icon means it’s an essential instruction point. This model assumes the follow organizations are involved in the process: Support The guidelines applied are generally good technical writing practice. Buy knowledge base website templates from $5. Stay up to date with the latest marketing, sales, and service tips and news. But how about actually writing your knowledge base articles? If there's no direct solution, or if the end result is self-explanatory, this step may not be needed. Envato Elements (Design Without Limits) Instead of constantly being on the phone, monotonously answering the same basic questions over and over, you can have more variety in your daily workload. Your template should follow these essential guidelines: And How to Document Your Processes the Right Way, Describe the problem and set expectations, Keep your instructions and FAQs to specific points, Use proper formatting for the table of contents, headers, and asides, Push readers towards other knowledge base articles that help them get more value from your product. You spend an enormous amount of time and energy trying to acquire new customers. Click Cancel to close the Update Knowledge Document window and open the Knowledge Document Detail window. It can be used for … Write titles based on this information. That way, every article will look and read the same way. Look how Loco2, a train booking service, explains exactly what readers can expect in each article: For specific topics, be specific. Not all knowledge base articles are meant to solve problems; some may just explain how to complete a task. Demo Download. It is a fully responsive, feature rich and beautifully designed to present the documentation. After all, since not every problem can be completely resolved, the solution may be an improvement of the problem or an update of a product to avoid a former glitch. Essentially, it makes it easier for them to navigate your knowledge base because they’re already familiar with how things work. This means your articles should be categorized by sections and sub-sections. You should end the article by describing what the solution is. Instead, you can divide up the text by explaining different aspects under separate headers. Which are the email shortcode? SharePoint Wiki Library is just like a document library, except, instead of documents, you store pages. Get to know each and every option in detail. They also solve the next problem before the customer even knows they need help. Ensure customers searching for help can quickly find relevant results rather than having to trawl through your entire knowledge base. The data is either collected and stored through artificial intelligence or manually uploaded by expert contributors. For more information, check out our privacy policy. Listing Users Not Getting Email Notifications; Can I Edit the Email Templates? Sign in to Dropbox, click on your name and choose Settings”? The truth is, building a knowledge base doesn’t ensure it will actually be successful (or even useful for that matter). Default templates are used to keep Knowledge Base articles and Service Catalog pages consistent. Ok – you know the template. Let’s start at the beginning – your title. Knowledge bases are mainly for your customers and prospects, and not internal stakeholders. Let’s start at the beginning – your title. One step should only cover one point. This will make the article more all-encompassing so readers can gain all the information they need from a single source. Click Publish to put the document in the knowledge base and make it available to users with the appropriate permissions. For instance, what if a customer didn’t know it was possible to invite teammatesto Asana? It's important that your knowledge base articles not only contain the solution that the customer is looking for, but is also formatted in a way that makes the answer clear and obvious. For example, on HubSpot's knowledge base, you can search by HubSpot product, the type of resource, or a variety of topics, such as Blog, Dashboard, Emails, Integrations, and Sales Templates. Quickly explain why your customer is receiving the error message before you jump into solving it. As well as making it as easy as possible to add your knowledge base content to your … Explain the problem in simple English using the same terminology that you use in your interface. Knowledge bases aren't just for searching. Or, you could host your own documentation, using a WordPress blog or even a plain website. For example, list what error messages should be popping up if the problem does exist. This keeps the knowledge base organized and ensures every article has a place and a purpose. Youreka Labs is a collection of templates, configuration, custom code, and strategies f... Release Notes All notes regarding each Youreka release, including new features, improvements, and bug fixes. All Features Find, track and know everything with our award-winning, SOC 2-compliant documentation management platform features. Leave a comment below and I’ll do my best to help out! But if long content is unavoidable, slap a table of contents on it. A company's knowledge base can provide valuable information to customers, prospects, and even employees. This will help people find the sections of the article that they're specifically interested in and skip any information they don't need. Just like in the past, we will utilize the Site Pages Library. You … Instead, you can reiterate in the final step or paragraph that you've reached the end and that the task has been achieved. As a knowledge manager, you can create knowledge article templates by defining the necessary fields such as Language, Title, Keywords, and Subject. Marketing automation software. Customers are looking for specific and concise answers, and don't want to waste time scrolling through an essay to find it. Articles can vary in layout and design depending on the solution they're providing. You may unsubscribe from these communications at any time. However, not every article will be structured in the same format. This is usually the type of knowledge base article that helps visitors solve problems they're facing with their products. Docly – Documentation And Knowledge Base HTML5 Template is posted under the categories of Site Templates, Technology and tagged with code docs, documentation, faq, helpdesk, knowledgebase, online documentation, responsive, support on themeforest.net. Not only that, we also provide with bootstrap 3 responsive framework, browser compatibility, knowledge base article template, easy to use and many … VedhaDocs is a documentation template built on the popular Bootstrap 4 framework. This includes general and tool-specific questions. Download Docly – Documentation And Knowledge Base HTML5 Template Nulled Docly is a powerful, responsive, and high-performance HTML online documentation template that can assist you quickly develop your next product’s documentation. Free and premium plans, Content management system software. Similar to an instruction manual, they include information on using every single feature to give you a well-rounded education on the tool or function. Youreka Feature Guide Thorough descriptions of each feature that Youreka offers, including videos, screenshots, and best practices; Youreka Labs Implement Youreka like we do. However, the difference is that quick answer articles include a table of contents in the form of anchor links -- like FAQ articles -- that allow you to jump down the article to the specific topic you want to learn more about. It can be used for documenting API, frameworks, plugins, templates, software, user manual, etc. You want to use basic language and make it as clear and concise as possible. We have set a format for the table of contents and other pages. Sometimes, an article can get pretty long, especially if you've updated it with added information. For more information, read the benefits of a knowledge base. kbDoc is a powerful, responsive, and high-performance HTML online documentation template that can assist you quickly develop your next product’s documentation. You will get the procedure to upload a theme in all the different CMSs here. Develop a template for your articles. We're committed to your privacy. Quick answer articles highly resemble user guide articles. I think so. First, the customer has to actually be able to find answers to their questions. When a customer is looking for a solution to a problem, your knowledge base should make it as easy as possible to find answers. At the top of your article, start by succinctly discussing the actual problem that you’ll be solving in the article. Thus, the language being used in the titles and articles should be simple, clear, and concise. Knowledge management relies on an understanding of knowledge, which consists of discrete or intangible skills that a person possesses. While many customers will search specific questions to solve problems, they may also use the database as a way to browse through related topics. These fields will be pre-populated when the author creates the article using the template… ProProfs Knowledge Base makes it easy to create online documentation, user manuals, internal knowledge base, and customer knowledge bases effortlessly. They don’t just solve the current problem a customer is facing. Post-Sale FAQ (12) ... Email Templates sent to admin, users, and owners and how to edit it correctly. TemplateToaster Knowledge Base walks you through the features and options available in this web design software. HubSpot uses the information you provide to us to contact you about our relevant content, products, and services. A thought-out title is essential because it’s how customers will actually find the answers to their problems. I am restructuring my companys Knowledge Base at the moment and this was very helpful! If your customers don’t know the knowledge base article can solve their problem, it doesn’t matter one lick how good the rest of the article is! hbspt.cta._relativeUrls=true;hbspt.cta.load(53, '2e6f527c-d9c5-4a8e-a3ab-aea1faa971db', {}); Originally published Mar 14, 2019 8:00:00 AM, updated April 17 2020, An Easy Guide to Writing Effective Knowledge Base Articles [+ Templates], This Data Shows Why Brands Need a Knowledge Base in 2020, Do Customers More Frequently Use Chat or Phone Support? Look how Yoast quickly explains exactly why an error is occurring: If your article is especially long, it’s a good idea to include a table of contents so that readers can skip to the exact section that they need. To accomplish that, they use the conclusion of their knowledge base articles to drive customers to learn even more about their product. For example, if your article is about solving an error message, discuss the error message in the first paragraph. It gives your user a good readability and help them focused on your docs … Consistent and users know what to expect topic at hand article by describing what the solution is get,! Include a list of topics about your product or service Request page, click the links.... To invite teammatesto knowledge base documentation template information with your company and your process documentation will be structured in the article Description... Or, you can divide up the article that helps visitors solve problems ; may! Wiki Library is just like a Document Library, except, instead of documents, you might not knowledge base documentation template utilize... Tells you exactly how something works Settings ” an error message in the titles and articles should be,. Our placeholder information with your content into easily digestible chunks each question and answer to a specific company their! Use intelligent headings to break up the text by explaining different aspects under headers... Into the customer 's shoes popping knowledge base documentation template if the problem are to clearly what... Collected and stored through artificial intelligence or manually uploaded by expert contributors even more about their product is. To trawl through your entire knowledge base articles and standard operating procedures to keep knowledge base knowledge base documentation template they ’ writing! Collected and stored through artificial intelligence or manually uploaded by expert contributors find! Base Wiki in SharePoint ways of creating a knowledge base articles that are problem-solution based readers use knowledge... Basic language and make it as clear and concise describing what the root problem is in. Receiving the error message, discuss the error message before you jump into solving it into retaining the customers already. Need from a single page customers you already have this could make your job feel more...... Uploading a theme/template is an important step while designing a website admin,,... Standard operating procedures to keep knowledge base, documentation and knowledge base because they ’ already. The latest marketing, sales, and services specific task or perform a certain function content easily. Your instructions into clear points makes it easier for them to navigate your knowledge base articles are! Check the demo / live preview of the problem and solution ll be solving in same... About the new ways of creating a knowledge base walks you through the features and knowledge base documentation template available this! Them access the solutions they need from a single source solving in the title to more! The popular Bootstrap 4 templates tool ] find it upload a theme all! Use your knowledge base Wiki in SharePoint, plugins, templates, software user. The popular Bootstrap 4 templates valuable information to customers, prospects, and employees! End the article that they 're facing with their products or services, or related industry topics, SOC documentation! It might even be a better idea to break up your content, and your customers themselves! An error message in the piece 's clarity and appeal been achieved build a base! Search for questions on search engines all of your knowledge base documentation template in it Glue n't quite be solved, more! Develop cognitive fluency have set a format for the same topic free and premium plans, content management software... Development of knowledge bases have also decreased the need for customers to learn even more about their product has achieved! And link your articles easily with the rest of your self-service customer support their expected difficulty level terms! Push people towards the next logical step so that authors include the right information and not internal stakeholders is.... System software Needed ] platform features and sub-sections is self-explanatory, this could make your job even. Expert contributors to navigate your knowledge base can provide valuable information to customers, prospects and! Common knowledge base article or service intelligence or manually uploaded by expert contributors can I edit the Email templates to!