Skip to content

Commit ffb995e

Browse files
authored
Merge pull request #1185 from layer5io/fm/docs-instructor-console-correction
docs(academy): correct Instructor Console guide against the shipped Overview metrics
2 parents 68c7d49 + 171063b commit ffb995e

1 file changed

Lines changed: 32 additions & 13 deletions

File tree

  • content/en/cloud/academy/creating-content/instructor-console-guide

content/en/cloud/academy/creating-content/instructor-console-guide/index.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,20 +53,35 @@ Below the creation tool is the main dashboard, which provides an overview of you
5353

5454
These charts display your most important, high-level statistics, giving you a snapshot of your academy's health:
5555

56+
<!-- Screenshot out of date: it shows the old three-card row (Total Learners / Active Learners /
57+
Total Test Taken). The shipped Overview has the five cards listed below. Recapture against the
58+
current console. Tracked in layer5io/docs#1184. -->
5659
![Core Metrics Dashboard](./images/core-metrics.png)
5760

61+
*This screenshot predates the current layout and is pending recapture. The console now shows the five cards described below.*
62+
5863
- **Total Learners**: Represents the overall reach of your academy. This is the total number of people who have ever shown interest in your content.
59-
- **Active Learners**: Measures current engagement. This is the number of learners currently working through content, giving you an idea of your active student body.
60-
- **Total Test Taken**: Indicates the level of interaction with your assessments.
64+
- **Active Learners**: Measures current engagement. This is the number of distinct learners who have worked with your content this calendar month, giving you an idea of your active student body.
65+
- **Registrations**: Every registration in the organization, whatever the state of the content it points at. This is the same total the [Learner Registration](#learner-registration) chart breaks down, so the two always agree.
66+
- **Completion Rate**: Registrations marked completed as a share of all registrations.
67+
- **Quiz Pass Rate**: The share of quiz attempts that passed, across every test in your organization. The card's subtitle carries the underlying counts (for example "762 of 1,036 attempts passed"), so the raw attempt total is still visible.
68+
69+
A rate card with nothing to divide renders as `-`, not `0%`. "Nobody has attempted this quiz yet" and "everybody failed it" are different facts, and reporting the first as zero would send you looking for a problem that isn't there.
6170

6271
**Strategic Uses**
6372
- Monitor Total Learners growth - steady increases indicate growing academy reach
64-
- Analyze Total Test Taken - high counts suggest challenging material requiring retakes, low counts may indicate learners avoiding assessments, assessments not being mandatory, or content being too easy
73+
- Analyze Quiz Pass Rate - a low rate suggests challenging material or unclear content, a very high rate may indicate assessments that are too easy. The attempt count in the card's subtitle distinguishes a low rate over many attempts (a real difficulty signal) from one over a handful (not yet meaningful).
6574

6675
{{< alert type="info" title="What Defines an 'Active Learner'?" >}}
67-
The **Active Learners** metric is a key indicator for engagement and billing, calculated based on the current status of content registrations.
76+
The **Active Learners** metric is a key indicator for engagement and billing. It counts *learners*, not registrations, and it is scoped to the current calendar month.
6877

69-
Specifically, it counts the number of registrations that are currently in the `Registered` status. This represents learners who have enrolled in your content but have not yet `Completed` it. It gives you a clear picture of your "in-progress" student body.
78+
A learner counts as active this month if, against academy content that is still live, they either created or touched a registration during the month, or submitted a quiz attempt during the month. A learner who does both counts once. A learner who enrolled months ago and takes a quiz this month is active this month, even though their registration row has not changed.
79+
80+
Because it counts distinct people over a monthly window rather than counting registrations, it is not directly comparable to the registration totals beside it, and it resets each month rather than accumulating. A learner who finished a curriculum long ago still counts as active in any month they take a quiz.
81+
{{< /alert >}}
82+
83+
{{< alert type="info" title="'Registrations' vs. 'Registrations Here'" >}}
84+
The **Curricula** tab has its own registrations card, named **Registrations Here**, which deliberately counts something narrower: only registrations against the published curricula listed on that tab. It is normally a smaller number than the Overview's **Registrations** card, which counts every registration in the organization including those against draft or retired content. That gap is expected, not a discrepancy - the card carries a tooltip explaining the difference.
7085
{{< /alert >}}
7186

7287
### Content Details
@@ -94,9 +109,11 @@ This chart provides an immediate visual summary of your learner base.
94109

95110
![Learner Registration](./images/learner-registration.png)
96111

97-
While the chart will only display statuses that currently have data, the system recognizes the following definitions, each represented by a specific color:
98-
- `Registered` (Blue): The learner has enrolled but has not yet completed the content.
112+
While the chart will only display statuses that currently have data, the system recognizes the following five definitions, each represented by a specific color:
113+
- `Registered` (Blue): The learner has enrolled but has not yet started the content.
114+
- `In Progress` (Amber): The learner has started the content but has not yet finished it.
99115
- `Completed` (Green): The learner has successfully finished all required parts of the content.
116+
- `Failed` (Crimson): The learner did not pass the content.
100117
- `Withdrawn` (Red): The learner has unenrolled from the content.
101118

102119
**Strategic Uses**
@@ -166,10 +183,12 @@ These statistics provide a high-level summary of all test activities in your aca
166183
- **Pass/Fail Summary Bar:** This bar chart gives you an at-a-glance comparison of the total number of passed attempts (green) versus failed attempts (red) across all tests.
167184

168185
- **Insight Cards:** These three cards automatically surface key trends and outliers from your data:
169-
- **Most Difficult Test:** The quiz with the lowest pass-to-fail ratio, helping you identify challenging content.
170-
- **Easiest Test:** The quiz with the highest pass-to-fail ratio.
186+
- **Lowest Pass Rate:** The quiz with the smallest share of passing attempts, helping you identify challenging content.
187+
- **Highest Pass Rate:** The quiz with the largest share of passing attempts.
171188
- **Most Attempted Test:** The quiz that learners have attempted the most times, regardless of the outcome.
172189

190+
The two rate cards rank on pass rate rather than on raw pass and fail counts, and only tests with at least five attempts are ranked. Ranking on counts would measure popularity instead of difficulty - the test the most people take holds both the most passes and the most failures - and the attempts floor stops a single learner failing a brand-new quiz from crowning it the hardest test. In a young academy where no test has reached five attempts yet, the ranking falls back to the full set.
191+
173192
#### Test Metrics
174193

175194
The **Test Metrics** list provides a detailed performance breakdown for each individual test. Each test title in this list is a clickable link that will take you directly to that assessment.
@@ -181,7 +200,7 @@ Use this list to quickly identify which specific assessments are causing the mos
181200
{{< /alert >}}
182201

183202
**Strategic Uses**
184-
- Investigate difficult tests - when a quiz appears in the **Most Difficult Test** card with low pass rates, review the content and questions for clarity
203+
- Investigate difficult tests - when a quiz appears in the **Lowest Pass Rate** card, review the content and questions for clarity
185204
- Monitor test attempt patterns - if **Most Attempted Test** has low pass rates, learners may be struggling with fundamental concepts
186205
- Use pass rate trends - improving pass rates suggest content optimization success, declining rates may indicate new content is too challenging
187206

@@ -199,7 +218,7 @@ Currently, the Instructor Console does not have a built-in feature to export the
199218
</details>
200219

201220
<details>
202-
<summary>Does "Total Test Taken" show the number of unique learners who took tests?</summary>
221+
<summary>Does "Quiz Pass Rate" count unique learners?</summary>
203222

204-
No. The "Total Test Taken" metric is a raw count of all attempts, including retakes by the same user. It is a measure of overall testing activity, not the number of unique learners who have been tested.
205-
</details>
223+
No. It is computed over attempts, not people: retakes by the same learner each count, so a learner who fails twice and then passes contributes two failures and one pass. It measures assessment outcomes, not how many distinct learners have been tested. For a headcount, use Total Learners or Active Learners.
224+
</details>

0 commit comments

Comments
 (0)