Skill review checklist
This will ensure that the intended response for each skill is returned. The checklist provides both required and optional requirements for each section.
Skill basics checklist
| Check box | Check | Required or Optional | Notes |
|---|---|---|---|
| ❑ | When defining the skill, clearly specify the purpose or intent of the skill. | Required | For example, Request PTO or Create
Requisition. Specify the action you would like performed. |
| ❑ | Define these skill properties so the skill is descriptive and easily searched:
|
Required | Optionally, prefix the skill name with a product acronym. Additionally, the skill name should be related to the purpose of the skill. |
| ❑ | Check your grammar. | Required | |
| ❑ | Check all languages if the skill is translated. | Required |
Requirements checklist
| Check box | Check | Required or Optional | Notes |
|---|---|---|---|
| ❑ | Specify the list of the requirements needed to fulfill the Skill. Limit the skill to 3 requirements. | Required | Additional requirements increase execution time and cost. The more requirements you have for the skill, the less the skill feels like a quick conversation. Responding to three questions in a row is not a problem, five questions feel tedious, and ten can be too lengthy. |
| ❑ | Select the appropriate requirement type for your prompt and expected values. | Required | The requirement will fail if the requirement type is not defined properly. For
example, if you ask for a date but the requirement type is Person. For more information on requirement types, see the Infor Coleman Digital Assistant User Guide. |
| ❑ | If your requirement must be specified in a certain format, you should provide an example. | Optional | For example, Input your phone number in this format:123-456-7890. |
| ❑ | Do not use String or Alphanumeric for requirements. | Required | |
| ❑ | Should you use a custom requirement type? | Optional | For example, if the set of values being prompted is a static set, you can use
Multiple Choice or Restrict. If your values have commonality, you can train an Expanded custom requirement type. |
| ❑ | If a requirement has a limited set of dynamic values, consider using a pre-requirement fulfillment to populate the dynamic requirement. | Optional | Use this option when there are less than 100 multiple-choice options for your requirement. |
| ❑ | If a requirement has an extended set of dynamic values, consider adding a new requirement to narrow the set of values to search from. | Optional | Use this option when there are more than 100 multiple-choice options for your requirement. |
Utterances checklist
| Check box | Check | Required or Optional | Notes |
|---|---|---|---|
| ❑ | When defining utterances, use these best practices:
|
Required | For more information on utterances, see the Infor Coleman Digital Assistant User Guide. |
| ❑ | Confirm that there are no utterances in your skill that are identical to utterances for another skill. This will cause inconsistency in skill invocation. | Required | You may inadvertently invoke a skill other than the intended skill. |
| ❑ | Your first utterance without a requirement should be the most descriptive. | Required | This utterance is displayed in the Help page in the Infor Coleman Digital Assistant interface. |
| ❑ | All utterances in a skill should have commonality with each other. | Required | These utterances are similar:
This utterance is not similar: What things can you do? |
| ❑ | All skills should have a similar number of utterances. | Required | If one of the skills has significantly more utterances than the rest, Coleman Digital Assistant will not be balanced. You may risk invoking the skill with more utterances erroneously. |
| ❑ | Ensure your utterances are complete sentences. | Optional | Try to avoid utterances that other skill builders are likely to use, for
example, Check status. Be specific if there are other skills that reference status. |
| ❑ | No string requirements in utterances | Optional | The String requirement type does not know when to stop parsing user input. This
can cause unexpected results when included in an utterance. For example, Check {product} status may struggle with Check my order status. Product may be used for my order. |
| ❑ | If you use a String requirement, you must use the requirement at the end of the utterance. | Required | The skill will perform better if the String requirement is relegated to the end of the utterance. But that this can still be problematic. |
| ❑ | Do not use an Alphanumeric or String requirement with another requirement in the same utterance. | Required | Alphanumeric requirements can have difficulty knowing when to stop parsing the
user input. For example, Order {item} for {product} will parse strange results for Order fifteen pounds of steel for the staff in Baltimore. |
| ❑ | Avoid abbreviations or acronyms in utterances if the skill is intended to be used vocally. | Optional | Infor Coleman Digital Assistant may have trouble understanding acronyms and abbreviations as verbal input. For example, DTO may be resolved as D tea O. |
Prompts checklist
| Check box | Check | Required or Optional | Notes |
|---|---|---|---|
| ❑ | Make sure that your first requirement prompt is contextual so that the user can confirm that the correct skill was invoked. | Required | For example, specify When would you like to submit a requisition request? versus What date? |
| ❑ | For high-impact requests, consider a Confirmation Prompt before executing the Skill Fulfillment. | Required | For example: I want to promote Jane Smith should require a confirmation prompt. |
| ❑ | Define multiple prompts to clarify invalid user input. | Optional | For example: What date? followed by Sorry, I didn't catch that. Specify a day such as Tuesday. |
Responses checklist
| Check box | Check | Required or Optional | Notes |
|---|---|---|---|
| ❑ | Confirm that your response contains enough information to be useful. Optionally, you can navigate to a page with the answer or provide a message response. | Optional | Consider the audience for the skill. Is the user in an office, warehouse, or in transit? |
| ❑ | If a requirement fulfillment fails, consider a Repeat Prompt action be used rather than Stop Skill. | Optional | |
| ❑ | Do not respond with raw API payload details. | Required | |
| ❑ | Include multiple responses for handing different types of errors. Ensure the user understands the reason for the error. | Optional |
Security checklist
| Check box | Check | Required or Optional | Notes |
|---|---|---|---|
| ❑ | Does your skill require restriction through security to a specific set of users or security roles? | Optional |