Creating Knowledge Base Articles
Learn how to create powerful help center articles.
Overview
Providing comprehensive and easily accessible support content is essential for customers and employees. Follow these steps to create effective Knowledge Base articles in your UserGuiding Help Center.
Steps to Create a Knowledge Base Article
- Go to the Articles tab on your Knowledge Base page.
- Click the +New Article button to start writing a new help article.
- Enter a concise, descriptive title and description for your article. These will be visible in your Help Center and search results.
- Compose the content of your article. Ensure it is clear, focused, and provides step-by-step instructions or information.
- Use subheadings (H1, H2, H3) to organize your content.
- Highlight important information with bold text.
- Insert images or videos to illustrate key points.
Format the Article
- Use the toolbar at the top of the editor to format your article:
- Insert images by uploading them from your device.
- Embed videos via supported platforms like YouTube, Vimeo, etc.
- Add code snippets if necessary.
- Create bulleted lists for easy scanning.
Enable Reactions and Feedback
- Enable the Reactions feature so users can react to the article with emojis.
Making Your Article Multilingual
Switch Languages
- After composing the article in your default language, switch to the language in which you want to add a translation.
Translate the Article
- Use the Auto-Translate Option or write the translated version of your article.
- Ensure all category and subcategory names are translated to maintain visibility and organization.
Publish Translated Versions
- Click the green Publish Article button to make the translated article available in your Help Center.
Publishing Your Article
- Once you are satisfied with the content, click the Save button.
- Add the article to the appropriate collection in your Help Center to ensure it is easily accessible.
- Once satisfied with all the settings and content, click the Publish Article button.
By following these steps, you can create informative and engaging Knowledge Base articles that provide valuable support to your customers and team members.