Skip to content

Commit

Permalink
doc path rename to 'code-eval-tool'
Browse files Browse the repository at this point in the history
  • Loading branch information
ganicke committed Dec 12, 2024
1 parent 0e41016 commit fa8bcca
Show file tree
Hide file tree
Showing 61 changed files with 80 additions and 80 deletions.
62 changes: 31 additions & 31 deletions docs/teachertool.md → docs/code-eval-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,35 @@

## Overview

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.
The [Code Evaluation 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.

## Teacher Tool Features
## Code Evaluation Tool Features

### Creating, Editing, and Running a Checklist

#### 1. Creating a new checklist

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.

![New Checklist](/static/teachertool/new-rubric.png)
![New Checklist](/static/code-eval-tool/new-rubric.png)

![New Checklist from menu](/static/teachertool/new-rubric-from-menu.png)
![New Checklist from menu](/static/code-eval-tool/new-rubric-from-menu.png)

#### 2. Naming a checklist

The checklist is given a name.

![Checklist name](/static/teachertool/checklist-name.png)
![Checklist name](/static/code-eval-tool/checklist-name.png)

#### 3. Add Criteria

One or more **_criteria_** are added from the catalog using the **Add Criteria** button.

![Add Criteria](/static/teachertool/add-criteria.png)
![Add Criteria](/static/code-eval-tool/add-criteria.png)

Some criteria (like `[block] used [count] times`) can be added multiple times, others (like `Read a GPIO pin` can only be added once).

![Criteria items](/static/teachertool/criteria-items.png)
![Criteria items](/static/code-eval-tool/criteria-items.png)

#### 4. Fill in Parameters

Expand All @@ -51,39 +51,39 @@ From a technical perspective, criteria parameters have these types:

Here a block is selected and used 3 times:

![Criteria parameters 1](/static/teachertool/parameters-1.png)
![Criteria parameters 1](/static/code-eval-tool/parameters-1.png)

Parameter options are displayed and then selected.

![Criteria parameters 2](/static/teachertool/parameters-2.png)
![Criteria parameters 2](/static/code-eval-tool/parameters-2.png)

![Criteria parameters 3](/static/teachertool/parameters-3.png)
![Criteria parameters 3](/static/code-eval-tool/parameters-3.png)

#### 5. Remove Criteria

A criteria item is removed using the **trash** button.

![Remove Criteria](/static/teachertool/remove-criteria.png)
![Remove Criteria](/static/code-eval-tool/remove-criteria.png)

#### 6. Load a project

A project into the project view by pasting in a share link or share ID.

![A loaded project](/static/teachertool/loaded-project.png)
![A loaded project](/static/code-eval-tool/loaded-project.png)

The project will load in read-only mode with the project title appearing at the top of the project view.

![Project validation](/static/teachertool/validate-me.png)
![Project validation](/static/code-eval-tool/validate-me.png)

#### 7. Run the checklist

With a project loaded, the checklist can run. The results are shown after clicking the **Run** button.

![Run checklist](/static/teachertool/run-checklist-button.png)
![Run checklist](/static/code-eval-tool/run-checklist-button.png)

The results view lists each criteria with its outcome.

![Checklist execution](/static/teachertool/checklist-execution.png)
![Checklist execution](/static/code-eval-tool/checklist-execution.png)

**Note**: the **Run** Button is disabled without loaded project.

Expand All @@ -93,29 +93,29 @@ The results view lists each criteria with its outcome.

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.

![Editing results](/static/teachertool/editing-results-1.png)
![Editing results](/static/code-eval-tool/editing-results-1.png)

![Editing results](/static/teachertool/editing-results-2.png)
![Editing results](/static/code-eval-tool/editing-results-2.png)

![Editing results](/static/teachertool/editing-results-3.png)
![Editing results](/static/code-eval-tool/editing-results-3.png)

#### 2. Edit outcomes

An outcome is edited using the provided dropdown.

![Edit outcome](/static/teachertool/edit-outcome-1.png)
![Edit outcome](/static/code-eval-tool/edit-outcome-1.png)

The new selected outcome.

![Edit outcome](/static/teachertool/edit-outcome-2.png)
![Edit outcome](/static/code-eval-tool/edit-outcome-2.png)

### Result Clearing and Auto-Run

#### 1. Toggling Auto-run

Auto-run is toggled either **on** or **off** using the button in the menu.

![Auto-run button](/static/teachertool/autorun-button.png)
![Auto-run button](/static/code-eval-tool/autorun-button.png)

#### 2. Auto-run disabled

Expand All @@ -135,44 +135,44 @@ If auto-run is **enabled**, any rules that enter the "Not started" state due to

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.

![Pre-built checklists](/static/teachertool/prebuilt-rubrics.png)
![Pre-built checklists](/static/code-eval-tool/prebuilt-rubrics.png)

#### 2. Export a checklist

A checklist is exported using the vertical "..." menu near the "auto-run" button.

![Export checklist](/static/teachertool/export-checklist.png)
![Export checklist](/static/code-eval-tool/export-checklist.png)

This will download a json file for the checklist.

![Checklist download](/static/teachertool/checklist-download.png)
![Checklist download](/static/code-eval-tool/checklist-download.png)

#### 3. Import a checklist

User can import a checklist from a file using the same "..." menu, or from the card on the welcome page.

![Import checklist card](/static/teachertool/import-checklist-card.png)
![Import checklist card](/static/code-eval-tool/import-checklist-card.png)

![Import checklist menu](/static/teachertool/import-checklist-menu.png)
![Import checklist menu](/static/code-eval-tool/import-checklist-menu.png)

Checklist file is selected using "Browse" or dropped directly into the popup. An overwrite confirmation prompted if there is currently an in-progress checklist.

![Import checklist drag in](/static/teachertool/import-checklist-dragdrop-1.png)
![Import checklist drag in](/static/code-eval-tool/import-checklist-dragdrop-1.png)

![Import checklist drop off](/static/teachertool/import-checklist-dragdrop-2.png)
![Import checklist drop off](/static/code-eval-tool/import-checklist-dragdrop-2.png)

### Other

If the page is refreshed (or if the browser closes/re-opens), the current checklist preserved.

Use the print button to create a version of the results with the outcomes and feedback visible (the other UI elements are hidden).

![Print button](/static/teachertool/print-button.png)
![Print button](/static/code-eval-tool/print-button.png)

The checklist-view/project-view splitter can be resized. It can also be reset to 50/50 split with double-click.

![View splitter button](/static/teachertool/view-splitter.png)
![View splitter button](/static/code-eval-tool/view-splitter.png)

Slide the splitter to widen the view of the criteria and results.

![Split view resize](/static/teachertool/split-resize.png)
![Split view resize](/static/code-eval-tool/split-resize.png)
Original file line number Diff line number Diff line change
Expand Up @@ -4,63 +4,63 @@
"cardType": "checklist-resource",
"cardTitle": "Rock Paper Scissors",
"imageUrl": "/static/mb/projects/a4-motion.png",
"checklistUrl": "/teachertool/checklists/rock-paper-scissors.json"
"checklistUrl": "/code-eval-tool/checklists/rock-paper-scissors.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Coin Flipper",
"imageUrl": "/static/mb/projects/coin-flipper.png",
"checklistUrl": "/teachertool/checklists/coin-flipper.json"
"checklistUrl": "/code-eval-tool/checklists/coin-flipper.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "7 seconds",
"imageUrl": "/static/mb/projects/7-seconds.png",
"checklistUrl": "/teachertool/checklists/7-seconds.json"
"checklistUrl": "/code-eval-tool/checklists/7-seconds.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Hot Potato",
"imageUrl": "/static/mb/projects/hot-potato.png",
"checklistUrl": "/teachertool/checklists/hot-potato.json"
"checklistUrl": "/code-eval-tool/checklists/hot-potato.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Tug-Of-LED",
"imageUrl": "/static/mb/projects/tug-of-led.png",
"checklistUrl": "/teachertool/checklists/tug-of-led.json"
"checklistUrl": "/code-eval-tool/checklists/tug-of-led.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Snap the dot",
"imageUrl": "/static/mb/projects/snap-the-dot.png",
"checklistUrl": "/teachertool/checklists/snap-the-dot.json"
"checklistUrl": "/code-eval-tool/checklists/snap-the-dot.json"
}
],
"cards.hidden": [
{
"cardType": "checklist-resource",
"cardTitle": "Rock Paper Scissors V2",
"imageUrl": "/static/mb/projects/a4-motion-v2.png",
"checklistUrl": "/teachertool/checklists/rock-paper-scissors-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/rock-paper-scissors-mbv2.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Heads Guess!",
"imageUrl": "/static/mb/projects/heads-guess.png",
"checklistUrl": "/teachertool/checklists/heads-guess.json"
"checklistUrl": "/code-eval-tool/checklists/heads-guess.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Reaction Time",
"imageUrl": "/static/mb/projects/reaction.jpg",
"checklistUrl": "/teachertool/checklists/reaction-time.json"
"checklistUrl": "/code-eval-tool/checklists/reaction-time.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Magic Button Trick",
"imageUrl": "/static/mb/projects/magic-button-trick.png",
"checklistUrl": "/teachertool/checklists/magic-button-trick.json"
"checklistUrl": "/code-eval-tool/checklists/magic-button-trick.json"
}
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cardType": "checklist-resource",
"cardTitle": "Level",
"imageUrl": "/static/mb/projects/level.png",
"checklistUrl": "/teachertool/checklists/level.json"
"checklistUrl": "/code-eval-tool/checklists/level.json"
}
],
"cards.hidden": []
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,37 @@
"cardType": "checklist-resource",
"cardTitle": "Pet Hamster",
"imageUrl": "/static/mb/projects/pet-hamster.png",
"checklistUrl": "/teachertool/checklists/pet-hamster-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/pet-hamster-mbv2.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Countdown",
"imageUrl": "/static/mb/projects/countdown.png",
"checklistUrl": "/teachertool/checklists/countdown-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/countdown-mbv2.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Morse Chat",
"imageUrl": "/static/mb/projects/morse-chat.png",
"checklistUrl": "/teachertool/checklists/morse-chat-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/morse-chat-mbv2.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Clap Lights",
"imageUrl": "/static/mb/projects/clap-lights.png",
"checklistUrl": "/teachertool/checklists/clap-lights-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/clap-lights-mbv2.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Blow Away",
"imageUrl": "/static/mb/projects/blow-away.png",
"checklistUrl": "/teachertool/checklists/blow-away-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/blow-away-mbv2.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Cat Napping",
"imageUrl": "/static/mb/projects/cat-napping/1_lychee.png",
"checklistUrl": "/teachertool/checklists/cat-napping-mbv2.json"
"checklistUrl": "/code-eval-tool/checklists/cat-napping-mbv2.json"
}
],
"cards.hidden": []
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,37 @@
"cardType": "checklist-resource",
"cardTitle": "Flashing Heart",
"imageUrl": "/static/mb/projects/a1-display.png",
"checklistUrl": "/teachertool/checklists/flashing-heart.json"
"checklistUrl": "/code-eval-tool/checklists/flashing-heart.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Name Tag",
"imageUrl": "/static/mb/projects/name-tag.png",
"checklistUrl": "/teachertool/checklists/name-tag.json"
"checklistUrl": "/code-eval-tool/checklists/name-tag.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Smiley Buttons",
"imageUrl": "/static/mb/projects/a2-buttons.png",
"checklistUrl": "/teachertool/checklists/smiley-buttons.json"
"checklistUrl": "/code-eval-tool/checklists/smiley-buttons.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Dice",
"imageUrl": "/static/mb/projects/dice.png",
"checklistUrl": "/teachertool/checklists/dice.json"
"checklistUrl": "/code-eval-tool/checklists/dice.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Love Meter",
"imageUrl": "/static/mb/projects/a3-pins.png",
"checklistUrl": "/teachertool/checklists/love-meter.json"
"checklistUrl": "/code-eval-tool/checklists/love-meter.json"
},
{
"cardType": "checklist-resource",
"cardTitle": "Micro Chat",
"imageUrl": "/static/mb/projects/a9-radio.png",
"checklistUrl": "/teachertool/checklists/micro-chat.json"
"checklistUrl": "/code-eval-tool/checklists/micro-chat.json"
}
],
"cards.hidden": []
Expand Down
Loading

0 comments on commit fa8bcca

Please sign in to comment.