AI content
General knowledge
The term "general knowledge" refers to any knowledge that we should expect our generative text model to have itself, without it being part of ShopWired's training data.
General knowledge refers to any subject, topic or information not exclusive to ShopWired and its functionalities.
ShopWired's AI is specifically instructed not to use its general knowledge to answer questions, but with some conditions:
- It should not use general knowledge to answer questions about ShopWired - it should only use its training data
- It can use its general knowledge to answer questions about coding, Twig or Liquid
- It can use its general knowledge to answer questions relating to SEO, Google Adwords, Google Shopping and other similar topics
Avoid adding general knowledge in AI content
We should refrain from adding general knowledge to AI content where at all possible.
AI content can include general knowledge in some specific scenarios (e.g. to ensure that a popular FAQ is answered correctly by AI but with the following conditions:
- Before adding general knowledge to AI content, first check the model (by asking the question) to see if it already has the knowledge before adding it to AI content
- Avoid adding general knowledge that provides advice or answers questions that don't directly relate to ShopWired functionality, for example for ShopWired's Xero app:
- AI content can be added that helps users to interpret error messages received by Xero when orders are exported as Invoices
- AI content should not be added that helps user use Xero (e.g. how to create an invoice manually in Xero)
- Avoid adding general knowledge that could become outdated
Selecting the right help guide
AI content should be added to the relevant help guide to which the content being added relates.
If AI content contains information about ShopWired features that stretch across multiple topics, avoid adding the content to a single help guide (e.g. by selecting the "most relevant"). Instead, segment the content across the relevant help guides.
AI guides
AI content can also be added to "AI guides". AI guides are similar to help guides but don't have a public/published set of content on ShopWired's help guide website. They are used to add training data for the AI (as the help guide content is the only content that is used by the AI as training data):
- Adding information to the AI that appears on ShopWired's website
- Adding information to the AI that appears on other ShopWired properties (e.g. the API documentation website)
- Adding information to the AI about ShopWired's infrastructure
- Adding information to the AI about ShopWired's corporate structure
Writing AI content
AI content should always be written in markdown and follow the markdown style guide.
AI content should always be written with British English spellings, and follow the same style guide as the style guide for published help guides.