Skip to content

Commit a89f1a7

Browse files
zihanKuangkirti763
authored andcommitted
draft
Signed-off-by: ZihanKuang <zihan_kuang@outlook.com>
1 parent 2414293 commit a89f1a7

File tree

6 files changed

+158
-0
lines changed

6 files changed

+158
-0
lines changed
198 KB
Loading
282 KB
Loading
3.31 MB
Loading
204 KB
Loading
219 KB
Loading
Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
title: "Instructor Console Guide"
3+
weight: 5
4+
description: >
5+
A comprehensive guide to using the Instructor Console. Learn how to track learner progress, analyze test performance, and manage your academy's content and metrics.
6+
categories: [Academy]
7+
tags: [Academy]
8+
---
9+
10+
The Instructor Console is your central command center for the Layer5 Academy. It's where you can get a bird's-eye view of your educational content and dive deep into how learners are engaging with it. Here, you can track learner progress, analyze test performance, and manage all of your academy's content and metrics.
11+
12+
### Gaining Access
13+
14+
To view the Instructor Console, you must be assigned the Academy Admin role.
15+
16+
{{< alert type="info" title="Enterprise Feature" >}}
17+
The Instructor Console and custom academy features are available exclusively for organizations on an Enterprise plan. [Learn more](https://layer5.io/pricing)
18+
{{< /alert >}}
19+
20+
If you are part of an organization with an Enterprise plan but do not see the console in your navigation, you'll need to request access. Reach out to your organization's system administrator. Ask them to assign the **Academy Admin** role to your user account.
21+
22+
Once the role is assigned, the Instructor Console will become visible in your navigation menu.
23+
24+
## Layout Overview
25+
26+
The Instructor Console is organized into several key sections that provide comprehensive insights into your academy's performance and learner engagement.
27+
28+
### Core Metrics
29+
30+
These four cards at the top provide your most immediate, high-level statistics:
31+
32+
- **Content Version**: This shows the version of the academy module your learners are currently using.
33+
- **Total Learners**: A running total of every unique user who has ever registered for any of your content.
34+
- **Active Learners**: The number of learners who are currently "in-progress." They have registered for content but have not yet completed it.
35+
- **Total Test Taken**: The total number of times any test has been attempted across all your courses. This counts retakes as well.
36+
37+
![Core Metrics Dashboard](./images/core-metrics.png)
38+
39+
40+
### Using the Content Creation Tool
41+
42+
The Instructor Console includes a Content Creation Tool to kickstart the development of new learning materials. It's a simple, guided process to help you generate the initial configuration for your content.
43+
44+
This Tool guides you through three quick steps to generate your content's boilerplate configuration.
45+
46+
![Content Creation Tool](./images/create-content-model.gif)
47+
48+
49+
1. **Basic Information**: First, you'll provide the essential details for your new content, such as its **Content Type** (Learning Path/Certification/challenge), **Title**, and **Description**.
50+
51+
| Feature | Learning Path | Challenge | Certification |
52+
| :--- | :--- | :--- | :--- |
53+
| Primary Goal | To teach and guide through a comprehensive curriculum. | To solve a specific, hands-on problem in a competitive scenario. | To validate and prove existing knowledge through formal examination. |
54+
| Main Content | Lessons, informational pages, labs, and progressive assessments. | A set of instructions for a practical task and a validation mechanism. | A series of exams, potentially with a brief study guide. |
55+
| Outcome | Acquired knowledge and skills. | A score, rank status. | An optional, paid official certificate and a verifiable badge.|
56+
57+
2. **Content Details**: Next, you'll refine additional properties for the content.
58+
59+
3. **Copy Template**: Finally, the Creation Tool presents you with a **"Generated Front Matter & Setup Guide"**. You will copy this YAML configuration and place it at the top of the corresponding `_index.md` file in your content repository.
60+
61+
{{< alert type="info" title="Console Creation Tool vs. Full Guides" >}}
62+
Think of the console's creation tool as a 'quick start' generator. It generates the necessary configuration boilerplate, but the detailed work of writing, structuring files, and publishing your content is done in your Git repository. For that, you'll need to follow our [comprehensive guides]().
63+
{{< /alert >}}
64+
65+
### Content and Registration Breakdowns
66+
67+
![Content Statistics Dashboard](./images/content-stats.png)
68+
69+
The dashboard offers a more granular look at your content's structure and your learners' overall status.
70+
71+
- **Content Stats**: This card gives you a quick count of the different types of content you've published. Each category is interactive; clicking on one will take you to the Academy Catalog, pre-filtered to show all your content of that type.
72+
73+
- **Registration Status**: This donut chart provides an immediate visual summary of your learner base. It shows the proportion of learners who are currently working through content (`registered`) compared to those who have successfully finished their courses (`completed`).
74+
75+
- **Content Metrics**: Think of this as a leaderboard for your content. It lists your courses and ranks them by the total number of registrations, giving you a clear view of what learners find most engaging. Each title is a direct link, allowing you to navigate straight to it.
76+
77+
### The All Learners Report
78+
79+
The Learners section is a detailed, interactive table that allows you to track individual progress, see who is taking which courses, and get a granular view of your learner base.
80+
81+
![All Learners Report](./images/learners.png)
82+
83+
**Understanding the Table**
84+
85+
Each row in the table represents a single user's registration for a specific content. Here's what each column means:
86+
87+
- **USER**: The learner's information. Clicking the avatar will take you to their public user profile.
88+
- **CURRICULA**: The specific content the user is enrolled in. Clicking the title will navigate you directly to that content.
89+
- **REGISTERED AT**: A timestamp indicating when the user enrolled. This is shown as a relative time (e.g., "6 hours ago") and will display the full date on hover.
90+
- **STATUS**: The learner's current standing in the course. Statuses include:
91+
- `Registered` (Blue): The learner has enrolled but has not yet completed the course.
92+
- `Completed` (Green): The learner has successfully finished all required parts of the course.
93+
- `Withdrawn` (Red): The learner has unenrolled from the course.
94+
95+
**Filtering and Finding Learners**
96+
97+
To find specific groups of learners, use the filter control located at the top-right of the table.
98+
99+
- **Filter by Content Type**: Want to see everyone enrolled only in Certifications? Select `Certification` from the 'Content Type' filter.
100+
- **Filter by Status**: Need a list of everyone who has successfully finished a course? Select `Completed` from the 'Status' filter.
101+
102+
**Customizing Your View**
103+
104+
To tailor the report to your needs, you can customize which columns are visible. Click the **View Columns** button at the top-right of the table.
105+
106+
A dropdown menu will appear, allowing you to check or uncheck columns to show or hide them. This is particularly useful for simplifying the view to focus on specific data.
107+
108+
**Navigating Through Pages**
109+
110+
When you have a large number of registrations, the report is split into multiple pages. Use the controls at the bottom-right of the table to navigate:
111+
112+
**Rows per page**: Select how many records you want to see on a single page (e.g., 10, 25, 50).
113+
114+
### Analyzing Test Performance
115+
116+
The final section is dedicated to analyzing the performance of your assessments.
117+
118+
#### Test Stats
119+
120+
The statistics on the left provide a high-level summary of all test activity in your academy.
121+
122+
![Test Statistics Overview](./images/est-stats.png)
123+
124+
- **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.
125+
126+
- **Insight Cards:** These three cards automatically surface key trends and outliers from your data:
127+
- **Most Difficult Test:** The quiz with the lowest pass-to-fail ratio, helping you identify challenging content.
128+
- **Easiest Test:** The quiz with the highest pass-to-fail ratio.
129+
- **Most Attempted Test:** The quiz that learners have attempted the most times, regardless of the outcome.
130+
131+
#### Detailed Test Metrics
132+
133+
The **Test Metrics** list on the right 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.
134+
135+
The percentage on the far right (e.g., `33%`) shows the overall pass rate for that specific test.
136+
137+
{{< alert type="info" title="Identifying Problem Areas" >}}
138+
Use this list to quickly identify which specific exams are causing the most trouble for your learners. A low pass rate on a particular quiz might indicate that the source material needs clarification or that the questions themselves are unclear.
139+
{{< /alert >}}
140+
141+
## Frequently Asked Questions
142+
143+
<details>
144+
<summary>I'm my organization's administrator. Can I assign Academy Admin roles?</summary>
145+
Yes, you can assign Academy Admin roles to users within your organization. As an administrator, you have the ability to manage user permissions and roles through your organization's user management system.
146+
</details>
147+
148+
<details>
149+
<summary>Can I export the All Learners Report to a CSV or Excel file?</summary>
150+
151+
Currently, the Instructor Console does not have a built-in feature to export the report directly to a file format like CSV. If you need this functionality urgently, please contact us at https://layer5.io/company/contact
152+
</details>
153+
154+
<details>
155+
<summary>Does "Total Test Taken" show the number of unique learners who took tests?</summary>
156+
157+
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.
158+
</details>

0 commit comments

Comments
 (0)