# Facet best practice

All attempts that you want to use the analytics system will need to contain questions that are faceted. There are 3 Types of facets:&#x20;

* Content&#x20;
* Skill&#x20;
* Difficulty&#x20;

{% hint style="warning" %}
We recommend that you do not use multiple of the same facets on a question, one question should only have one of each facet set to it. This is important for how the data displays in graphs to students&#x20;
{% endhint %}

{% embed url="<https://www.youtube.com/watch?feature=emb_title&v=vcF5jKUJluQ>" %}
Walk through of results page using full facets
{% endembed %}

This section will use the below tags as an example to explain how facets have been decided.

![ Tags and their facets](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2F44hEOBg7QZkIdX3XlNHr%2Fall_tags_facet_2022.png?alt=media\&token=1e5e75c5-4870-4025-a759-8f90c630e1ad)

### 📗 Content facets

All the content tag facets work together as part of a hierarchy. Use content facets to describe the material and show the relationship between content. The available facets are from highest to lowest: **Exam, Module, Subject, Topic** and **Subtopic**.&#x20;

{% hint style="info" %}
Performance by facet can be displayed on a results page, excluding Exam and Module facets
{% endhint %}

We recommend starting with **Subject, Topic** and **Subtopic** as they are the most important in terms of the breakdown graphs, and set a good benchmark to organise the rest of your content.&#x20;

![](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FVsWVUoPhMIiez0eXud6u%2Fcontent_facets_simple.png?alt=media\&token=c5e0e120-cbc6-4b77-aae3-990d614a9d75)

Alcohol is the subject, as it is what all of its corresponding topics and subtopics have in common.

Topics are: Wine, Spirits, Beers because their corresponding subtopics can be grouped together by that topic.&#x20;

Subtopics are: Red wine to Lagers, as subtopics as they are all independent enough from each other but are related back to their corresponding topic and subject. Spirits relates to Whiskey and Vodka, but not to IPA and Lager. All of them still relate to Alcohol, the subject

It's important to remember that these are all still tags, we are just adding an extra layer of definition on top of them.

Once you've defined a set of content tags, users, admins and educators will be able to see an attempt breakdown against each facet in the results for that quiz or exam.

![Example of content broken down by subject, topic and subtopic ](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FE1QIljlyg4moVHnoVVVP%2F2_overview_topic.png?alt=media\&token=7e452552-15dd-4796-81f8-255f7f867cc3)

#### Additional content facets&#x20;

Add Exam and Module facets on top of content to provide an extra layer of grouping&#x20;

![Content facets with Exam and Module added](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2Fc3PxEW8kO3Dm2qxME21z%2Fcontent_facets_complex.png?alt=media\&token=d6f15bfe-63c6-40c6-95b6-9d79cffa36e1)

In this example Fermentation is the module and Biology the exam. Biology has many modules to it that could be used here to further group content together.

### 📘 Skill facets

Setting up skill facets will enable the skill breakdown chart on the results page. You may find there is some overlap between skills and content tags, for example algebra is a skill but also a subject. The trick here is to prioritise what you want the users to see and visualise.

![Skill facet examples](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2Ftsy5z3CxCoFKoY11QWg9%2FScreenshot%202022-01-10%20at%2016.48.41.png?alt=media\&token=03d15804-ab2f-4a4d-9b00-72ce2e66d994)

{% hint style="info" %}
**Skill definition for best practice**\
A skill is a learned ability or proficiency in a specific area. It is something that a person becomes better at through practice. For example: **Verbal Reasoning, Problem Solving, Decision Analysis.**
{% endhint %}

### 📙 Difficulty facets

Similar to skill, difficulty tags will display a score on an attempt by difficulty. We don't impose any requirements on what is or isn't a difficulty. Tags that require a difficulty facet should be fairly independent and easy to identify from all other facet types.<br>

![Difficulty facet examples](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2Fa2g8BoRCws37HztlhSKW%2Fdifficulty_facet_2022.png?alt=media\&token=21c69203-bfa5-4eaa-be4b-94a727f82468)

{% hint style="info" %}
**Difficulty definition for best practice**\
A difficulty is the level of effort involved in answering a question correctly. Something that is difficult requires more effort, skill or knowledge to complete. Examples of difficulty are: **Easy, Medium, Hard** <br>
{% endhint %}

![Example graphs breaking down by Skill and Difficulty facets](https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FhV3tGYV2nCMywNsduuWF%2Fskill_diff.png?alt=media\&token=78a7d067-9040-4d86-bdb4-2ad0b633edb7)

In general skills are what your users need to possess to answer a question well, and difficulty is how much effort and how many of those skills are required to answer it. Keep this in mind when setting up your facets. You may wish to not assign difficulty facets until your questions have been used by a large group, then you can export data on your questions to see what the correct answer rate of each questions is. Then create difficulty tags based on those responses. (Feel free to get in touch with support to talk about this in more detail)&#x20;

###


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/analytics/tags-and-facets/facet-best-practice.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
