Skip to content

Commit bd21da2

Browse files
CarkHTCarkHT
authored
Update to student user documentation for new UI (#19)
Updated: docs/teacher/guides/content-sets-questions.md docs/teacher/guides/gettingstarted.md docs/student/faq.md docs/student/getting_started_student.md docs/student/index.md
1 parent eca81d5 commit bd21da2

15 files changed

Lines changed: 72 additions & 56 deletions

‎docs/student/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Frequently Asked Questions
22

3-
## Why I cannot find the module I am looking for?
3+
## Why can't I find the module I am looking for?
44

55
Access to each module is provided by the teacher owning the module.
66

‎docs/student/images/pdf_button.png‎

8.96 KB
Loading

‎docs/student/images/question_overview.png‎

122 KB
Loading

‎docs/student/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ The image above shows an example question, with numbers to indicate:
1717
8. Part selection (tabs)
1818
9. _Part content_ (only visible when relevant part is open - (a),(b), etc.)
1919
10. _Response area_, where student responses are entered and feedback is given
20-
11. Feedback to the teacher (currently in flux regarding the design - 31/8/22)
20+
11. Feedback to the teacher (currently in flux regarding the design - 02/07/25)
2121
12. Access to content 'below the line' providing extra support.
22-
22+
13. _Workspace_ - Opens tab with canvas and ai chatbot
23+
14. Comments
2324

2425
## Below the line
2526

2627

2728
![Below the line buttons screenshot](images/Traffic_Light_Only.png){: style="height:50px"}
2829

2930

30-
- _My solutions_ - create your own content. Drag and drop images or type content. Use standard markdown.
3131
- _Structured tutorial_ - teachers use this in different ways. It is generally a way to provide scaffolding if you're struggling.
3232
- _Final Answer_ - warning, don't ever look at the answer before you make your own genuine attempt at answering the question.
33-
- _Worked solutions_ - warning, don't ever look at the solutions before you make your own attempt. If necessary, look at the first line and reveal a step at a time.
33+
- _Worked solutions_ - warning, don't ever look at the solutions before you make your own attempt. If necessary, look at the first line and reveal a step at a time.

‎docs/teacher/guides/content-sets-questions.md‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
# Editing questions
22

3-
In this guide, we will walk through how to create [sets](https://lambda-feedback.github.io/user-documentation/terminology#sets) and [questions](https://lambda-feedback.github.io/user-documentation/terminology#questions).
3+
This guide explains how to use the editor to create and modify [sets](https://lambda-feedback.github.io/user-documentation/terminology#sets) and [questions](https://lambda-feedback.github.io/user-documentation/terminology#questions).
44

5-
1. <ins>Click on a Set</ins> in order to edit or add questions.
5+
## <ins>Click a Set</ins> to edit or add questions to it.
6+
![](./images/content-sets-questions-10.png)
67

7-
![set panel entry](./images/content-sets-questions-10.png)
8+
## A guide to the editor:
9+
![](./images/content-sets-questions-11.png)
810

9-
2. A guide to the editor:
10-
11-
![set panel entry](./images/content-sets-questions-11.png)
12-
13-
| Label | Name | Description |
14-
| ----- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15-
| 1 | Question Name | Here we can edit the name given to the question |
16-
| 2 | Master content | Always visible. Uses a milkdown component. |
17-
| 3 | Current part | References which question part we are editing. |
18-
| 4 | Part Content | Here we can edit the specific content of the part (the sub question). |
19-
| 5 | Response Area | This is the means by which the student answers a given question. It is optional to include a response area. |
20-
| 6 | Question Help Options | Here we may add a [Structured Tutorial](https://lambda-feedback.github.io/user-documentation/terminology#structured-tutorial), a [Final Answer](https://lambda-feedback.github.io/user-documentation/terminology#final-answer) ("Show Answer"), or [Worked Solutions](https://lambda-feedback.github.io/user-documentation/terminology#worked-solution). These buttons are also how the student will see them, hence the name of "Show Answer". |
21-
| 7 | Teacher-Student View Toggle | Here we may toggle between the teacher view ("EDIT"), and the student view ("PREVIEW"). This way we can edit the question, but also see a preview of how it would look to the student. |
22-
| 8 | Edit Guidance | Here we can add further details for guidance, estimated working time and skill level. |
23-
| 9 | Part option | Here we can add, duplicate or (if there are more than one) delete a question part. |
24-
| 10 | Add question | Here we can add create a new blank question, duplicate a question or upload a zip file containing JSON file(s) for Lambda Feedback. |
25-
| 11 | File, Preview and Stats | Travel to pages to a) File: version management/ download as JSON and delete question b) Preview: view the question as a student would see it c) Stats: View stats of student responses of the question set. |
11+
| Label | Name | Description |
12+
| :--- | :--- | :--- |
13+
| **1** | **Add Question** | Add a new blank question, duplicate an existing question, or upload a .zip file containing one or more question JSON files. |
14+
| **2** | **File, Preview, and Stats** | Access pages for:<br>• **File:** Manage versions, download as a JSON file, or delete the question.<br>• **Preview:** See the question as a student would.<br>• **Stats:** View statistics on student responses for the question. |
15+
| **3** | **Question Name** | Edit the name of the question. |
16+
| **4** | **Master Content** | The main content for the question, which is always visible above the individual parts. This field uses the Milkdown editor. |
17+
| **5** | **Current Part** | **Indicates** which question part you are currently editing. |
18+
| **6** | **Part Content** | Edit the content for the selected question part (i.e., the sub-question). |
19+
| **7** | **Response Area** | The input field where a student submits their answer. Adding a response area is optional. |
20+
| **8** | **Question Help Options** | Add optional support materials for students, such as a [**Structured Tutorial**](https://lambda-feedback.github.io/user-documentation/terminology#structured-tutorial), a [**Final Answer**](https://lambda-feedback.github.io/user-documentation/terminology#final-answer), or [**Worked Solutions**](https://lambda-feedback.github.io/user-documentation/terminology#worked-solution). The buttons shown here are the same ones students will see. |
21+
| **9** | **Teacher/Student View Toggle** | Toggle between the teacher editing view ('EDIT') and the student 'PREVIEW' to see how the question will appear to students. |
22+
| **10** | **Edit Guidance** | Add extra details for the question, such as guidance notes, estimated completion time, and skill level. |
23+
| **11** | **Part Options** | Add a new part, duplicate the current part, or delete a part (only available if there is more than one). |

‎docs/teacher/guides/gettingstarted.md‎

Lines changed: 49 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,101 @@
1-
# Get started as a teacher using Lambda Feedback
1+
# Getting Started with Lambda Feedback for Teachers
22

3-
## Access a module
3+
## Access a Module
44

5-
Use your Imperial Microsoft account to sign in and access your modules. By default you are logged in as a student and the interface will be blue. If you have teacher priviliges then you will see a teacher button at the top.
5+
Use your Imperial Microsoft account to sign in and access your modules. By default, you are logged in as a student, and the interface will be blue. If you have teacher **privileges**, you will see a 'Teacher' button at the top.
66

77
![Buttons](images/Student_Mode_Arrow.PNG)<br />
88

9-
To enter teacher mode, <ins>click on the Teacher button</ins>, and the colour of the interface will change to orange. This is where you are able to access all your modules, as well as upload and edit problem sets.
9+
To enter teacher mode, <ins>click the 'Teacher' button</ins>, and the **colour** of the interface will change to orange. This is where you can access all your modules, as well as upload and edit problem sets.
1010

11-
As of 07/2023, new modules can only be added to Lambda Feedback by administrators. Please speak to an admin if you wish for your module to be added to the website.
11+
As of **July 2023**, new modules can only be added to Lambda Feedback by administrators. Please **contact an administrator** if you want your module added to the website.
1212

1313
![Teacher](images/Teacher_Mode_Orange.PNG)<br />
1414

15-
To find the module you want, you can sort ASCENDING as per the image below:<br />
15+
To find the module you want, you can sort them in **ascending/descending order**, or filter them as shown below:
16+
<br />
1617
![Sort](images/Sort_Modules.png){: style="height:200px"}
1718
![Filter](images/Filter_Modules.png){: style="height:200px"}<br />
18-
_Image: quick sort (left) or filtering (right)_
19+
_Image: Quick sort (left) or filtering (right)_
1920

20-
As of 31/8/22 the filtering/sorting only works on the content visible on the current page (other pages are ignored). We aim to fix this by sorting at the backend.
21-
22-
Select the module you wish to edit.<br />
21+
Select the module you wish to edit.
22+
<br />
2323
![Select module](images/Teacher_Module_Selection.png)
2424

25-
## Create a new problem set
25+
## Create a New Problem Set
2626

27-
<ins>Click on your module</ins> and then <ins>click on "content"</ins> (upper left-hand corner).<br />
27+
<ins>Click your module</ins> and then <ins>click 'Content'</ins> (in the upper-left corner).
28+
<br />
2829
![View sets](images/Teacher_View_Sets2.png)
2930

30-
Create a new set by pressing the button seen below and this will automatically appear with a default name which you can edit by clicking 'edit set metadata':<br />
31-
![Create set](images/create_set.png){: style="height:50px"}
31+
Create a new set by **clicking** the 'Create Set' button.
32+
33+
A menu will appear with options to edit the name, description, and other settings for the new set.
3234

33-
To edit the content, <ins>click on the set name</ins>. This will open the Set in a ['WYSIWYG'](https://en.wikipedia.org/wiki/WYSIWYG) editor. The first question is automatically created with a default name.
35+
To edit the content, <ins>click the set name</ins>. This will open the set in a ['WYSIWYG'](https://en.wikipedia.org/wiki/WYSIWYG) editor. The first question is automatically created with a default name.
3436

3537
The question structure is described [here](../../student/index.md).
3638

37-
## Below the line
39+
## Below the Line
3840

39-
Below the main question content you can provide high quality support material for students.
41+
Below the main question content, you can provide high-quality support material for students.
4042

4143
![Below the line buttons screenshot](../../student/images/Traffic_Light_Only.png){: style="height:50px"}
4244

43-
A [student guide is here](../../student/index.md) and teachers use the content as follows:
45+
A [student guide is here](../../student/index.md). Teachers use the 'below the line' content as follows:
4446

45-
- **Structured tutorial** is a canvas to provide scaffolding to students struggling with the question.
46-
- **Final answer** is self explanatory.
47-
- **Worked solutions** provides detailed, step-by-step solutions.
47+
- **Structured tutorial** is to provide scaffolding for students struggling with the question.
48+
- **Final answer** is self-explanatory.
49+
- **Worked solutions** provides detailed, step-by-step solutions.
4850

49-
All content below the line uses milkdown functionality. Worked solutions can be branched. Future developments will add branching and response areas to structured tutorials.
51+
All content below the line uses Lexdown functionality. Worked solutions can be branched. Future developments will add branching and response areas to structured tutorials.
5052

51-
It is not necessary to include all three methods of help, if only one of the tabs is filled then only that one button will be included in the published student version.
53+
It is not necessary to include all three methods of help. If you only provide content for one tab, only that button will appear in the published student version.
5254

5355
For general terminology, see [here.](../../terminology.md)
5456

5557
To see further details on how to edit your questions, see [here.](content-sets-questions.md)
5658

57-
## Enrolling students
59+
## Enrolling Students
60+
61+
In **Teacher mode**, open your module's home page, click the 'Students' tab, and then click 'Enrol Students'.
62+
63+
![Teacher view students](../../teacher/guides/images/Teacher_view_students.png)
64+
65+
Enter a student's email address, or alternatively paste in a list of email addresses separated by commas.
66+
67+
![Add_student_before](./images/Add_student_before.png)
5868

59-
In TEACHER mode, open your module home page and click 'VIEW STUDENTS' then 'ENROL STUDENTS'
69+
Press 'Enter' to add the email addresses:
6070

61-
![View students button](../../teacher/guides/images/view_students.png) ![Enrol students button](../../teacher/guides/images/enrol_students.png)
71+
![Add_student_after](./images/Add_student_after.png)
6272

63-
Enter a comma-separated list of email addresses. Press 'Enter' to confirm the addresses, and then 'SUBMIT' to enrol the students
73+
Then click 'SUBMIT' to enrol the students.
6474

65-
### Imperial College London email addresses
75+
### Imperial College London Email Addresses
6676

67-
You must use the long form email address:
77+
You must use the long-form email address:
6878

6979
#### Valid:
7080

7181
first.nameYY@imperial.ac.uk (student)
82+
<br>
7283
j.doe@imperial.ac.uk (staff)
84+
<br>
7385
first.name@imperial.ac.uk (staff)
86+
<br>
7487

75-
#### Invalid
88+
#### Invalid:
7689

7790
abc123@ic.ac.uk
91+
<br>
7892
abc123@imperial.ac.uk
93+
<br>
7994
user@ic.ac.uk
95+
<br>
8096
user@imperial.ac.uk
97+
<br>
8198
first.nameYY@ic.ac.uk
99+
<br>
82100

83-
The reason for the above is because we use Azure Active Directory - i.e. Microsoft - to authorise users.
101+
This is because we use Azure Active Directory (i.e., Microsoft) to **authorise** users.

‎docs/teacher/guides/images/Add_student_after.png‎

34.6 KB
Loading

‎docs/teacher/guides/images/Add_student_before.png‎

26.6 KB
Loading

‎docs/teacher/guides/images/Teacher_View_Sets.png‎

-158 KB
Binary file not shown.

‎docs/teacher/guides/images/Teacher_View_Sets2.png‎

57.7 KB
Loading

0 commit comments

Comments
 (0)