Knowledgebase File Guideline

    Last updated on April 11th, 2024

    Description

    The primary objective of the knowledge base is to encompass information that is not currently supported by Uberall's location data.

    This style guide outlines a series of standards and recommendations for crafting your Knowledgebase file. It aids in ensuring that our Chatbot delivers the most optimal responses.

    The general style guide is essentially structured in Markdown format.

    Format Guide

    Sections

    The knowledge base can be segmented into multiple sections, each with its own distinct context or theme.

    You can delineate each section using the following set of characters: "---".

    Section Header  

    Should be clear and concise, It should perfectly describe the main theme of the section. a section header is best to be prepended with # character to indicate its the title of the section

    Section Body

    The body contains in-depth information about a product, service or guides users through a series of detailed instructions or troubleshooting steps. The body section should use the following format guidelines:

    Numbererd Lists 

    Use numbered lists for step-by-step directions

    Bulleted Lists

    Use bulleted lists for a list of related items.

    Order of Instructions

    Write in a logical order.  Write the instructions in the order that the user will go through

    Question and Answer Format

    Utilizing a question and answer format can significantly enhance our chatbot's ability to formulate responses and provide clearer contextual information.

    Example

    Q: Do you offer Holiday Discount?
    A: During holiday we provide family discounts
    Q: Can I give away my gift voucher to anyone?
    A: Unfortunately no

    Sample

    # Hamburger Making Procedure:
    1. Gather Ingredients.
    2. Prepare Patty.
    3. Season Patty.
    4. Cook Patty.
    5. Assemble Burger.
    6. Serve.
    ---
    # Hamburger Sourcing: Our Farm-to-Table Journey
    Our hamburgers are sourced from local farms renowned for their commitment to sustainable and ethical practices.
    These farms prioritize the well-being of their livestock, ensuring they are raised in spacious and natural environments,
    free from antibiotics and hormones. Additionally, they emphasize responsible land management and strive to minimize their environmental footprint. 
    We take pride in partnering with these farms to offer our customers high-quality, 
    flavorful hamburgers that are not only delicious but also reflect our dedication to supporting local communities and sustainable agriculture.
    ---
    # Discounts and Gift Voucher
    Q: Do you offer Holiday Discount?
    A: During holiday we provide family discounts
    Q: Can I give away my gift voucher to anyone?
    A: Unfortunately no

    Content considerations

    Ensure consistency between the knowledge base and location data to prevent confusion. In cases of discrepancy, prioritize location data for generating responses.

    We strongly recommend thoroughly testing and experimenting with your knowledge base before deploying it to production. This ensures that all information is aligned with your business's data and objectives.

    Was this article helpful?

    Save as PDF