{"id":11583,"date":"2024-04-02T15:00:00","date_gmt":"2024-04-02T09:00:00","guid":{"rendered":"https:\/\/betterdocs.co\/?p=11583"},"modified":"2024-04-09T15:26:09","modified_gmt":"2024-04-09T09:26:09","slug":"show-related-documentation-and-attachments","status":"publish","type":"post","link":"https:\/\/betterdocs.co\/it\/show-related-documentation-and-attachments\/","title":{"rendered":"How to Show Related Documentation and Attachments in Your Knowledge Base\u00a0"},"content":{"rendered":"

A knowledge base<\/strong> is like a big online library for a business or organization. It is a place where you can find all sorts of useful information. Creating a proper knowledge base is essential so that users get information faster. Showing related documents and attachments makes your knowledge base more user friendly.<\/p>\n\n\n\n\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

Con BetterDocs <\/strong>plugin, you can easily show related documentation and attachments<\/a> in the documents. Today we will learn how to show related documentazione <\/strong>e attachments <\/strong>in your knowledge base in a streamlined way. So without further delay, let us jump in to the details<\/p>\n\n\n\n

Why Would You Show Related Documents in Your Knowledge Base<\/strong><\/h2>\n\n\n\n

Putting related documents in your website’s knowledge base is really helpful for several reasons, making things better for people who use it. Here is why you should show related documents in your Knowledge Base:<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

\ud83d\udd06 Easy to Find Out:<\/strong> When you link documents that are related to the particular doc, people can find those documents more easily. They might start with one question but then discover other useful information they did not even think to ask about. This helps them understand more without much hassle.<\/p>\n\n\n\n

\ud83d\udd06 Better Understanding:<\/strong> Sometimes, one document is not enough to get the whole picture, especially with tricky topics. Related documents can add more details or different viewpoints, helping people get a fuller understanding.<\/p>\n\n\n\n

\ud83d\udd06 Saves Time: <\/strong>People often have questions that are connected. If you put links to related documents right where people are reading, they will not have to spend extra time looking for answers. This makes your knowledge base faster and more friendly to use.<\/p>\n\n\n\n

\ud83d\udd06 Keeps People Interested:<\/strong> If you offer more useful information that is related to what someone is already looking at, they are likely to stick around longer. This can make them more satisfied with your help and more likely to come back.<\/p>\n\n\n\n

In short, adding related documents to your knowledge base is a smart way to make it more useful, easy to use, and helpful for everyone, no matter how they like to learn.<\/p>\n\n\n\n

Why You should Add Attachments to Your Knowledge Base<\/strong><\/h2>\n\n\n\n

Adding attachments to the documents in your knowledge base makes the information you are sharing much more helpful and detailed. Here is how it makes a big difference:<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

\ud83d\udd06 Comprehensive Information:<\/strong> Attachments let you add a lot more details that support your main points. This could be things like big sets of data, long instructions, or extra resources that are too big or detailed to fit into the main part of the document.<\/p>\n\n\n\n

\ud83d\udd06 Diverse Content Formats:<\/strong> Everyone has their own way they like to learn and get information. With attachments, you can offer info in various formats like PDFs, spreadsheets, slideshows, or videos. This means people can choose what works best for them, making it easier and more enjoyable to learn.<\/p>\n\n\n\n

\ud83d\udd06 Enhanced Clarity to the User:<\/strong> If you are explaining how to do something, attachments can be really handy. Things like how-to videos, templates, or step-by-step guides can give practical help that goes beyond just talking about it. This can make it easier to understand how to do something and make mistakes less likely.<\/p>\n\n\n\n

\ud83d\udd06 Increased Reliability and Trust: <\/strong>When you offer detailed resources as attachments, it shows that you have done your homework. People are more likely to trust and value the information if they see it is backed up by solid evidence or detailed materials.<\/p>\n\n\n\n

Overall, adding attachments to knowledge base documents is essential for delivering a rich, versatile, and user-centered informational resource that meets the comprehensive needs of its audience.<\/p>\n\n\n\n

Showcase Related Documentation & Attachments in Knowledge Base with BetterDocs<\/h1>\n\n\n
\n
\"Show<\/figure>\n<\/div>\n\n\n

A knowledge base is more than just a place to store information. It is the main way to help your users when they have questions. By adding links to related articles and attachments, you can make it even easier for them to find what they need. To make this process easier, BetterDocs<\/strong><\/a> <\/strong>comes on the field that makes adding these helpful features simple and efficient.<\/p>\n\n\n\n

BetterDocs is a WordPress plugin designed to <\/strong>create and manage a knowledge base<\/strong><\/a> with ease. It provides many features that help to enhance the accessibility and efficiency of your support documentation. With many advanced features, BetterDocs helps you design a user-friendly knowledge base with easy FAQs<\/strong>, instant answers<\/strong>, etc and reduces support ticket volume by enabling users to find solutions quickly.\u00a0<\/p>\n\n\n\n

Besides, you can easily organize your documentation with categories and tags, and use BetterDocs\u2019 smart algorithm to display related articles, enhancing user navigation. Moreover BetterDocs allows for easy incorporation of various types of attachments within your articles, ensuring that users have access to all necessary resources in one place.<\/p>\n\n\n\n

BetterDocs is a Freemium WordPress plugin. Though its free version offers many exclusive features for your website\u2019s documentation, these two features are premium. You need the PRO version for display related documentation and attachments. So, before we dive into the details, make sure you have installed <\/strong>e activated BetterDocs PRO<\/strong><\/a>.\u00a0<\/p>\n\n\n\n

Quick Guide to Show Related Documentation with BetterDocs<\/strong><\/h2>\n\n\n\n

A comprehensive knowledge base is not just about having a vast amount of content but also about making that content accessible and interconnected. Look at below to learn the step by step guide to show related documents<\/strong> inside your singe documents:<\/p>\n\n\n\n

Step 1: Enable the Add \u2018Related Docs\u2019 Feature<\/strong><\/h3>\n\n\n\n

From WordPress dashboard, navigate to BetterDocs \u2192 Settings \u2192 Layout \u2192 Single Doc \u2192 Related Docs. Now toggle on  the “Show Related Docs” option to enable this feature\u200b\u200b and click \u2018Save\u2019.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

Step 2: Create New Documentation or Open Any Existing One<\/strong><\/h3>\n\n\n\n

Go to BetterDocs \u2192 Add New to create a new document. BetterDocs supports manual documentation creation and AI-assisted writing for efficiency and ease\u200b\u200b. Or, you can open any existing documentation where you want to showcase the related doc.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

Step 3: Add Related Docs<\/strong> <\/strong><\/h3>\n\n\n\n

In the document editor, you will find an option to add related documents. You can select related documents by expanding categories and choosing the relevant docs you wish to link to your current document\u200b\u200b.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

So finally that is how you can easily add related docs in a single doc page with BetterDocs on your WordPress site. Have a look below and see how it will look. For more details, follow this step by step guide<\/strong><\/a>.\u00a0<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

Enhance Your Documents Through Attachments <\/strong><\/h2>\n\n\n\n

Attachments add clarity, provide context, and serve as handy reference resources. Now let us know how to add attachments <\/strong>in your knowledge base:<\/p>\n\n\n\n

Step 1: Activate the \u2018Attachment\u2019 Feature<\/strong><\/h3>\n\n\n\n

As you have installed and activated BetterDocs PRO. First go to BetterDocs \u2192 Settings \u2192 Layout \u2192 Single Doc, find the ‘Attachment’ tab, and turn on the ‘Show Attachment’ option.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

Step 2: Configure Attachment Preferences<\/strong><\/h3>\n\n\n\n

Adjust settings to your liking, including label text<\/strong>, default file name<\/strong>, and whether to show the size and icon for attachments. Opt for opening attachments in a new tab if needed. If you choose to display attachment icons, you’ll have the chance to upload custom icons for various file types like images, PDFs, audio, and more. Finally Click on the \u2018Save\u2019 button to save your changes.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

Step 3 : Add Attachments to Your Documentation<\/strong><\/h3>\n\n\n\n

Now, locate the ‘Add Attachments’ option at the bottom. Click on it, choose files from your media library or upload them, and attach. Update the document to apply the changes.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

\u2b50Nota: <\/strong>If you’re using a block-based theme<\/strong><\/a>, attachments won’t be displayed by default. You’ll need to manually add the ‘BetterDocs Attachment’ block in the site editor under Appearance \u2192 Editor \u2192 Templates \u2192 Single Docs. Place the block where you’d like attachments to appear, and save your changes.<\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

After following these steps, your attached files will be visible at the bottom of your single document pages, enhancing your knowledge base for readers. Have a look below. <\/p>\n\n\n

\n
\"Show<\/figure>\n<\/div>\n\n\n

This is how it will showcase in your documentation. This process not only simplifies the addition of valuable resources but also makes your documentation more comprehensive and useful. For more details, read this documentation.<\/strong><\/a><\/p>\n\n\n\n

Show Related Documentation and Attachments with Ease<\/strong><\/h2>\n\n\n\n

A knowledge base is more than a repository of information, it is a dynamic resource for any website. Showing related documentation to the knowledge base saves your user\u2019s lot of time. On the other hand, adding attachments to the knowledge base increases the trust of the users. Also, these little but useful features make the documents more organized,  more engaging for the reader. <\/p>\n\n\n\n

Con <\/strong>BetterDocs<\/strong><\/a> you can do these tasks with a streamlined process. As you keep integrating BetterDocs into your knowledge base, remember it is a chance to really change how you support your users. Start now, and set yourself up for a future where each time a user visits your knowledge base, it is an opportunity to learn, solve a problem, and connect.
If you have found this blog informative enough, subscribe to our blog<\/a> for more blogs like this. Join our Facebook community<\/a> to share your experience with other WordPress users.<\/p>","protected":false},"excerpt":{"rendered":"

Enhance your knowledge base by learning how to show related documentation and attachments<\/p>","protected":false},"author":38,"featured_media":11586,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_eb_attr":"","inline_featured_image":false,"_eb_data_table":"","_analytify_skip_tracking":false,"footnotes":"","_wpscppro_dont_share_socialmedia":false,"_wpscppro_custom_social_share_image":0,"_facebook_share_type":"","_twitter_share_type":"","_linkedin_share_type":"","_pinterest_share_type":"","_linkedin_share_type_page":"","_instagram_share_type":"","_medium_share_type":"","_threads_share_type":"","_google_business_share_type":"","_selected_social_profile":[],"_wpsp_enable_custom_social_template":false,"_wpsp_social_scheduling":{"enabled":false,"datetime":null,"platforms":[],"status":"template_only","dateOption":"today","timeOption":"now","customDays":"","customHours":"","customDate":"","customTime":"","schedulingType":"absolute"},"_wpsp_active_default_template":true},"categories":[34,58],"tags":[909,26,910,908,28,907,906],"class_list":["post-11583","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-betterdocs","category-tutorial","tag-attachments-in-knowledge-base","tag-betterdocs","tag-betterdocs-feature","tag-doc-attachment","tag-knowledge-base","tag-related-docs","tag-related-documentation"],"nelio_content":{"autoShareEndMode":"never","automationSources":{"useCustomSentences":false,"customSentences":[]},"efiAlt":"","efiUrl":"","followers":[38],"highlights":[],"isAutoShareEnabled":true,"networkImageIds":[],"permalinkQueryArgs":[],"series":[],"suggestedReferences":[]},"_links":{"self":[{"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/posts\/11583","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/users\/38"}],"replies":[{"embeddable":true,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/comments?post=11583"}],"version-history":[{"count":3,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/posts\/11583\/revisions"}],"predecessor-version":[{"id":16805,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/posts\/11583\/revisions\/16805"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/media\/11586"}],"wp:attachment":[{"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/media?parent=11583"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/categories?post=11583"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/betterdocs.co\/it\/wp-json\/wp\/v2\/tags?post=11583"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}