How to Create a Knowledge Base Article in Confluence

Owned by Aeoleon Bryant
Sept 06, 2024
2 min read

Introduction

This guide walks you through the process of creating a knowledge base (KB) article. Whether you're documenting a process, troubleshooting steps, or answering frequently asked questions, Confluence makes it easy to create structured and searchable articles for your team.

Steps to Create a Knowledge Base Article in Confluence

Step 1: Navigate to the Space for Your Knowledge Base.

  • Log in to Confluence: Open your browser and log in to your Confluence account.

  • Select the Space: From the dashboard, select the appropriate space where your KB article will be located. Spaces are organized repositories for different projects or teams.

    • If your team has a designated KB space, use that.

Step 2: Create a New Page

  • Click on the "Create" button: On the top navigation bar, click the "Create" button. This opens a new page editor.

Step 3: Add the Title and Content

  • Enter a title: Choose a clear, descriptive title for your article. Titles should summarize the article’s content, making it easy to find through search.

    • Example: "How to Reset Your Password"

  • Add sections to your page: Organize your article into sections for clarity.

    • Introduction: A brief overview of the article’s purpose.

    • Step-by-step instructions: Use headings, numbered lists, or bullet points for each step. For example:

      1. Navigate to the login page.

      2. Click "Forgot Password".

      3. Enter your email address.

    • Conclusion: Summarize the key takeaways or link to additional resources.

Step 4: Format the Content

  • Use headings and subheadings: Format your text with clear headings (H1, H2, H3) to make the content easy to read.

  • Add images or diagrams: Include screenshots, diagrams, or GIFs where necessary. To insert images:

    • Click the image icon in the editor toolbar.

    • Upload or drag-and-drop the image into the page.

    • Use captions or labels to describe the images.

  • Highlight key information: Use bold or italics to emphasize important points, and consider using tables or callouts for clarity.

Step 5: Publish the Article

  • Click "Publish": Once you've reviewed the content and are satisfied, click the "Publish" button at the bottom right of the page. Your article will now be live in the space and searchable by your team.

Step 6: Share the Article

  • Copy the link: Once the article is published, you can copy the URL and share it with your team or add it to other documentation for easy access.

    • Use the "Share" button to quickly send the link to specific team members via Confluence's notification system.

Additional Information

  • Best Practices: Regularly review and update your knowledge base articles to ensure they remain relevant and accurate. Incorporate feedback from team members to improve the clarity and completeness of the article.

By following these steps, you can create professional and easy-to-follow knowledge base articles in Confluence, ensuring your team has access to clear and organized documentation.

Â