Skip to content

Commit d59b6a5

Browse files
ganickethsparks
andauthored
Teacher tool top level doc page (#5800)
* container doc * screen images * image batch 2 * image import batch 3 * do some revisions to the features text * remove video/gif placeholder * update title * Update docs/teachertool.md Co-authored-by: Thomas Sparks <[email protected]> * replace 'rubric' with 'checklist' * pull parameter types out of main text --------- Co-authored-by: Thomas Sparks <[email protected]>
1 parent fb92c01 commit d59b6a5

30 files changed

+178
-0
lines changed
22.3 KB
Loading
18.6 KB
Loading
Loading
Loading
22.9 KB
Loading
98.5 KB
Loading
18.1 KB
Loading
8.85 KB
Loading
10.2 KB
Loading
13.4 KB
Loading
11.7 KB
Loading
85.4 KB
Loading
Loading
Loading
Loading
Loading
112 KB
Loading
54.3 KB
Loading
47.2 KB
Loading
81.1 KB
Loading
57.8 KB
Loading
79.3 KB
Loading
64.1 KB
Loading
36.5 KB
Loading
82.4 KB
Loading
96.2 KB
Loading
63.9 KB
Loading
27.5 KB
Loading
131 KB
Loading

docs/teachertool.md

+178
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
# Code Evaluation Tool
2+
3+
## Overview
4+
5+
The [Teacher Tool]( https://microbit.makecode.com/beta--eval) is a mechanism for constructing a checklist of requirements for an assignment and running that list automatically against projects in quick succession. This allows teachers to build a checklist, then easily evaluate any number of projects based on that checklist. Projects are evaluated one at a time, but with auto-run enabled, you can update the loaded project by providing a new share link, at which point the rules will automatically be re-run on the new project.
6+
7+
## Teacher Tool Features
8+
9+
### Creating, Editing, and Running a Checklist
10+
11+
#### 1. Creating a new checklist
12+
13+
Create a new checklist using the **New Checklist** card. If there is already an "in progress" checklist, a warning will appear asking if it is okay to overwrite it.
14+
15+
![New Checklist](/static/teachertool/new-rubric.png)
16+
17+
![New Checklist from menu](/static/teachertool/new-rubric-from-menu.png)
18+
19+
#### 2. Naming a checklist
20+
21+
The checklist is given a name.
22+
23+
![Checklist name](/static/teachertool/checklist-name.png)
24+
25+
#### 3. Add Criteria
26+
27+
One or more **_criteria_** are added from the catalog using the **Add Criteria** button.
28+
29+
![Add Criteria](/static/teachertool/add-criteria.png)
30+
31+
Some criteria (like `[block] used [count] times`) can be added multiple times, others (like `Read a GPIO pin` can only be added once).
32+
33+
![Criteria items](/static/teachertool/criteria-items.png)
34+
35+
#### 4. Fill in Parameters
36+
37+
Parameters for the criteria item are filled in for a criteria item.
38+
39+
### ~ tip
40+
41+
#### Parameter types
42+
43+
From a technical perspective, criteria parameters have these types:
44+
45+
- **Numeric** parameters have a small input and only allow number inputs.
46+
- **String** parameters can have medium and long sized inputs.
47+
- **Block** parameters should open a block-picker modal.
48+
- **Empty** parameters appear in an error state until they have values.
49+
50+
### ~
51+
52+
Here a block is selected and used 3 times:
53+
54+
![Criteria parameters 1](/static/teachertool/parameters-1.png)
55+
56+
Parameter options are displayed and then selected.
57+
58+
![Criteria parameters 2](/static/teachertool/parameters-2.png)
59+
60+
![Criteria parameters 3](/static/teachertool/parameters-3.png)
61+
62+
#### 5. Remove Criteria
63+
64+
A criteria item is removed using the **trash** button.
65+
66+
![Remove Criteria](/static/teachertool/remove-criteria.png)
67+
68+
#### 6. Load a project
69+
70+
A project into the project view by pasting in a share link or share ID.
71+
72+
![A loaded project](/static/teachertool/loaded-project.png)
73+
74+
The project will load in read-only mode with the project title appearing at the top of the project view.
75+
76+
![Project validation](/static/teachertool/validate-me.png)
77+
78+
#### 7. Run the checklist
79+
80+
With a project loaded, the checklist can run. The results are shown after clicking the **Run** button.
81+
82+
![Run checklist](/static/teachertool/run-checklist-button.png)
83+
84+
The results view lists each criteria with its outcome.
85+
86+
![Checklist execution](/static/teachertool/checklist-execution.png)
87+
88+
**Note**: the **Run** Button is disabled without loaded project.
89+
90+
### Editing Results
91+
92+
#### 1. Add feedback and notes
93+
94+
Feedback and notes are added using the **Add Notes** button. The feedback box should resize to fit its content as notes are added. The original feedback remains even if you re-run the rules using the **Run** button.
95+
96+
![Editing results](/static/teachertool/editing-results-1.png)
97+
98+
![Editing results](/static/teachertool/editing-results-2.png)
99+
100+
![Editing results](/static/teachertool/editing-results-3.png)
101+
102+
#### 2. Edit outcomes
103+
104+
An outcome is edited using the provided dropdown.
105+
106+
![Edit outcome](/static/teachertool/edit-outcome-1.png)
107+
108+
The new selected outcome.
109+
110+
![Edit outcome](/static/teachertool/edit-outcome-2.png)
111+
112+
### Result Clearing and Auto-Run
113+
114+
#### 1. Toggling Auto-run
115+
116+
Auto-run is toggled either **on** or **off** using the button in the menu.
117+
118+
![Auto-run button](/static/teachertool/autorun-button.png)
119+
120+
#### 2. Auto-run disabled
121+
122+
If auto-run is **disabled**, a result's outcome (i.e. "Looks good", "Needs work", etc...) is set to "Not started" automatically if any of any of the following conditions are met:
123+
124+
- It is newly added (defaults to the "Not Started" state).
125+
- A parameter in a rule is changed (only the affected rule enters the "Not Started" state).
126+
- The loaded project changes (all rules are be set to "Not started").
127+
128+
#### 3. Auto-run enabled
129+
130+
If auto-run is **enabled**, any rules that enter the "Not started" state due to the conditions listed above are immediately and automatically re-run with their results updated.
131+
132+
### Loading/Importing/Exporting Checklists
133+
134+
#### 1. Pre-built checklists
135+
136+
There are pre-built checklists are available from on home page. If a selected checklist is already in-progress, an overwrite confirmation prompt is given.
137+
138+
![Pre-built checklists](/static/teachertool/prebuilt-rubrics.png)
139+
140+
#### 2. Export a checklist
141+
142+
A checklist is exported using the vertical "..." menu near the "auto-run" button.
143+
144+
![Export checklist](/static/teachertool/export-checklist.png)
145+
146+
This will download a json file for the checklist.
147+
148+
![Checklist download](/static/teachertool/checklist-download.png)
149+
150+
#### 3. Import a checklist
151+
152+
User can import a checklist from a file using the same "..." menu, or from the card on the welcome page.
153+
154+
![Import checklist card](/static/teachertool/import-checklist-card.png)
155+
156+
![Import checklist menu](/static/teachertool/import-checklist-menu.png)
157+
158+
Checklist file is selected using "Browse" or dropped directly into the popup. An overwrite confirmation prompted if there is currently an in-progress checklist.
159+
160+
![Import checklist drag in](/static/teachertool/import-checklist-dragdrop-1.png)
161+
162+
![Import checklist drop off](/static/teachertool/import-checklist-dragdrop-2.png)
163+
164+
### Other
165+
166+
If the page is refreshed (or if the browser closes/re-opens), the current checklist preserved.
167+
168+
Use the print button to create a version of the results with the outcomes and feedback visible (the other UI elements are hidden).
169+
170+
![Print button](/static/teachertool/print-button.png)
171+
172+
The checklist-view/project-view splitter can be resized. It can also be reset to 50/50 split with double-click.
173+
174+
![View splitter button](/static/teachertool/view-splitter.png)
175+
176+
Slide the splitter to widen the view of the criteria and results.
177+
178+
![Split view resize](/static/teachertool/split-resize.png)

0 commit comments

Comments
 (0)