Below are guidelines for writing different types of data integration articles.

Data Type articles

• Always include the What/Why/How section at the top of each Data Type overview article.  It is best to copy from an existing article and modify it as needed.

• Under How, if we have step-by-step instructions for specific vendors, list those vendors and link to the corresponding articles.  You can use the @ sign while typing to quickly link to an existing article (after doing so, remove all but the vendor name from the link text).

Vendor articles

• For integrations where we ask for a login, always include these two sections:
  • Allow Clarivoy to export your leads data for you
    • Include the specific instructions on how the customer should create the login.
    • Remember, we want all email addresses to use the format datateam+dealername@clarivoy.com
  • Exporting Leads on your Own
    • Use the Numbered List feature in HelpJuice (don't type out the numbers on each step; let it number them for you).  Use CTRL+ENTER if you want to include a line break but not go to the next numbered step.
      Here's Why:  This makes it much easier to add a step in the middle later if the vendor revises their system.
      • Write each step as a complete sentence and end it with a period.
      • There is no need to add a line break after each numbered item to space them out.  Although it does not appear in the editor while writing the article, HelpJuice will add a space after each numbered article in the published article.  You can click the “Preview” button to see the results at any time.
    • Include screenshots of each relevant step.
      • Blur out or erase any dealer information or customer PII in the screenshots.
      • Edit your screenshot and circle the action item in red (the item you are asking the dealer to click on).
    • Within each step, word it in the order that the customer would follow on the screen.
    • For example, if the vendor page looks like this:
      
      Don’t Write:  Check the boxes for Chat and Form under Lead Action Type.
      Do Write:  Under Lead Action Type, check the boxes for Chat and Form.
      Here's why:  The customer needs to first look for “Lead Action Type” and then under that section click Chat and Form (Not the other way around).
    • Bold the words the customer should click on to help it stand out, especially if it is the name of a button on the screen.
      Examples:
      • Check the boxes for Chat and Form.
      • Click on the Save Filters button.
    • At the end, always include:
      • Instructions on how to save the file, including what keywords (vendor name) the dealer should include in the filename
      • The URL for our upload site and instructions on how to upload the file (what “File Type” to check).
• After the end of the customer instructions, you may want to include internal instructions on how to load the data.  Use the Insert Internal Block button to do this.  Instructions in the Internal Block are only visible to Clarivoy employees when logged into HelpJuice.