Moveworks FAQ Formatting Guide

View as MarkdownOpen in Claude

Overview

The Moveworks platform provides an extensible method to add Knowledge FAQs to the bot by allowing customers to add FAQ Style Question/Answer snippets that may not warrant a full knowledge base article. This guide outlines how to take advantage of rich formatting to efficiently communicate complex data.

FAQ Notes:

  • Be mindful of the character limit title \< 511 characters  
  • More words does not equal better triggering in the title. Recommendation is 10-20 words (50-150 char)
  • Applies to all domains
  • Formatting is only support for Answers NOT Questions. All Questions will be BOLD by default with no formatting options

Supported Formatting:

  • Bold - Surround your text with asterisks
  • Italics - Surround your text with underscores
  • Hyperlinks - Use the following format for hyperlinks
    • <https\://link_to_hyperlink|click here>
  • Bullet points - Use asterisks (*) and a new line to denote bullet points:
    • bullet point number 1
    • bullet point number 2

FAQ Images

Create a new line in the FAQ with the following format:

Column C is labeled: image_url
Column D is labeled: thumb_url

Add image URL to Column C and thumbnail URL to Column D (optional).

To add an image please use a publicly accessible URL (upload to Google, Imgur etc) and wait for a Moveworks ingestion cycle to pick up the image.

Image can be no larger than 1000x1000.