Aviator knowledge sources

Add text-based instructions and guidelines for Aviator to improve the relevance and accuracy of its responses.

Overview

With knowledge sources, you can guide Aviator to respond to prompts using extra information beyond the data from the queried item. Knowledge sources can contain extensive information, or provide precise guidelines about how to respond. For details, see Knowledge source use cases.

Knowledge sources can be defined at the shared space level to apply to all its workspaces, and to individual workspaces.

Knowledge source use cases

Here are some use cases for leveraging knowledge sources to implement standard work practices across all areas of your team's work.

Company policy

Create knowledge sources detailing company regulations, its main business, security requirements and general data about the organization. The knowledge sources should be purposed to be used by every Aviator query, so that the responses are all informed by your company's basic information.

As these are general knowledge sources that Aviator should relate to in every request, you can define them at the shared space level to apply to all workspaces in the space.

Standard item creation

Create a knowledge source that lists the standard user stories that should always be included in a feature. When the knowledge source is invoked on a feature, Aviator suggests user stories based on the feature's description and the user stories outlined in the knowledge source.

Create a knowledge source that includes a standard outline for feature specifications. When the knowledge source is invoked on a feature, Aviator rewrites the feature description according to the outline, and highlights information that needs to be added to comply with the standard specification structure.
Create a knowledge source that contains templates for various item types, as defined by the team. The knowledge source's sections can describe the standard wording and structure for item types such as defects and tests.

Root cause analysis

Populate a knowledge source with your knowledge-base articles and best practices. When the knowledge source is invoked on a defect, Aviator uses the information to analyze the defect's root cause based on past experience and compared to expected behavior.

Test automation assistance

Populate a knowledge source with test code guidelines and examples, based on the framework used by the automation team. Using the knowledge source, Aviator can help write test automation for user stories, according to the team definition.

Technical design assistance

Populate a knowledge source with product architecture documents and technical data. Aviator can be used to fill in gaps regarding a feature's technical design, or to answer questions using expert knowledge.

Assistance with field value assignment

Create a knowledge source with field value mappings that determine the best values for a field according to other information in the same item. For example, define rules for assigning a feature to an application module or to a team. When the knowledge source is invoked on an item, Aviator can suggest the most appropriate application module or team to assign to the item.

Feature delivery process assistance

Populate a knowledge source with details of what's expected at each phase of the release process. According to an item's current lifecycle phase, Aviator helps the user understand the next steps to perform on the item.

Create a knowledge source

Create a knowledge source at the space or workspace level.

To create a knowledge source:

Open the global menu and select Administration > General Settings.
Select a shared space or workspace.
Select the Aviator tab.
Click the + Knowledge source button.

Note the following special fields.

Field	Description
Purpose	Helps Aviator decide when to use this source. Describe the topics, scope, and relevance of the source. Example: "Covers internal product guidelines and feature behavior. Use for questions about the functionality or best practices."
Applicable entity types	Select the entities in which the source will be used, or select none to apply the source to all entities. Note: The listed entities are those in which Aviator is available.
Description	A user-facing description of the source. The description is displayed to the user in the list of references that Aviator uses in its responses.
Available to users	To limit the use of the knowledge source to certain users, select the users. Leave the field blank to make the knowledge source to all users.

Click the Add & Edit button. The Instructions tab opens.
Click the Add text section button.
Add textual guidelines or information in the section.
To organize the instructions in separate sections, click the Add text section button to add another section.
To activate the knowledge source:
1. Return to the Details tab
2. Set the Is active field to Yes.
3. Check the Validity status field. If the status is Not valid, check that the knowledge source contains instructions.

Test knowledge sources

Before publishing a knowledge source to all users, use the Available to users field to enable it for yourself only and test it using relevant prompts on an item.

Check that Aviator's response uses the knowledge source for appropriate prompts. The response's sources are listed in the References section.

According to the quality of the responses, continuously adjust the source's instructions until you receive satisfactory results.

If the knowledge source is not used, check the following:

Check the Validity status field. Not valid sources are not used by Aviator.
Make sure the Is active field is set to Yes.
In the Available to users field, make sure the knowledge source is available to the right users.
In the Applicable entity types field, make sure that the knowledge source is assigned to the right entities.
Check the Purpose description. Aviator users the Purpose field to match user requests with the relevant knowledge sources.

Use knowledge sources

Aviator uses knowledge sources automatically when there's a match between a user request and a source's purpose. Users can see which sources were used in the list of references at the end of a response.

If a knowledge source is designed to be part of a standard process, you can create a custom Aviator chip that uses the source.

Example:

Create a knowledge source that provides a standard structure for feature descriptions.
Add a custom chip: Rewrite the feature description with an appropriate underlying prompt.

For details, see External actions.

Result:

The chip in the Aviator sidebar reminds authors to run the prompt.
The prompt uses the matching knowledge source to offer a rewritten feature description.