Skip to content

Commit e6a827b

Browse files
authored
assessment updates 3 (#433)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Restructured assessment guides to concise, reference-style workflows; collapsed Metadata/Files steps into a single Create action. * Added a top-level "Grading a Grade Book Assessment" section and expanded grading narratives and review guidance. * Standardized image handling (inline with explicit widths), typography (LaTeX), and cross-references. * Condensed auto-generation instructions into references to AI assessment generation; streamlined grader names/options and expanded partial‑points examples (Python/JS). <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 6bab765 commit e6a827b

12 files changed

Lines changed: 150 additions & 217 deletions
66.3 KB
Loading
47.5 KB
Loading
45.7 KB
Loading
89.1 KB
Loading

source/instructors/authoring/assessments/advanced-code-test.rst

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ The advanced code test assessment type allows you to easily implement unit tests
1010
To ensure that your test scripts run securely and to prevent student access to your testing files or executables, place them in the **.guides/secure** folder. Create a folder if one does not already exist. This folder is not available to students in their assignments and they cannot access it from the command line. Only teachers with editing privileges have access to the **.guides/secure** folder.
1111

1212

13-
.. Note:: If your assignment will contain multiple assessments, Code files and Test Cases for individual assessments should be placed in separate folders to avoid compiling all files.
13+
.. note:: If your assignment will contain multiple assessments, Code files and Test Cases for individual assessments should be placed in separate folders to avoid compiling all files.
1414

1515

16-
Complete each section to set up your advanced code test. For more information on **General**, **Metadata** and **Files** see :ref:`Assessments <assessments>`.
16+
Complete each section to set up your advanced code test. For more information on **General**, **Metadata** (Optional) and **Files** (Optional) see :ref:`Assessments <assessments>`.
1717

1818
1. Complete **General**.
1919

@@ -27,30 +27,26 @@ Complete each section to set up your advanced code test. For more information on
2727
- **Python**: `pycodestyle`_ or `UnitTest`_
2828
- **JavaScript**: `JSHint and JSLint`_
2929

30-
.. Note:: For more information, see the :ref:`test-types` section or click any test name above to navigate directly to that section.
30+
.. note:: For more information, see the :ref:`test-types` section or click any test name above to navigate directly to that section.
3131

3232
- **Language Assessment Subtype** - Click the drop-down and choose a subtype for the selected language type, if applicable.
3333

3434
- **Timeout** - You can amend the timeout setting for the code to execute. Arrows will allow you to set max 300 (sec). If you require longer, you can manually enter the timeout period.
3535

3636
3. Click **Grading** in the top navigation pane and complete the following fields:
3737

38-
.. image:: /img/guides/ACTGradingScreen.png
39-
:alt: Grading
40-
:width: 500px
41-
42-
- **Points** - The score given to the student if the code test passes. You can enter any positive numeric value. If this assessment should not be graded, enter 0 points.
43-
- **Partial Points** - Toggle to enable a percentage of total points to be given based on the percentage correctly answered. Note that it's not enough to turn partial points on; the advanced code test has to be written to handle partial points. See :ref:`Partial Points <partial-points>` for more information.
44-
- **Define Number of Attempts** - enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts.
45-
- **Show Rationale to Students** - Toggle to display the rationale for the answer to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**
46-
- **Rationale** - Enter guidance for the assessment. This is always visible to the teacher when the project is opened in the course or when opening the student's project.
47-
- **Use maximum score** - Toggle to enable assessment final score to be the highest score attained of all runs.
48-
49-
4. **(Optional)** Complete **Metadata**.
38+
.. image:: /img/guides/ACTGradingScreen.png
39+
:alt: Grading
40+
:width: 500px
5041

51-
5. **(Optional)** Complete **Files**.
42+
- **Points** - The score given to the student if the code test passes. You can enter any positive numeric value. If this assessment should not be graded, enter 0 points.
43+
- **Partial Points** - Toggle to enable a percentage of total points to be given based on the percentage correctly answered. Note that it's not enough to turn partial points on; the advanced code test has to be written to handle partial points. See :ref:`Partial Points <partial-points>` for more information.
44+
- **Define Number of Attempts** - enable to allow and set the number of attempts students can make for this assessment. If disabled, the student can make unlimited attempts.
45+
- **Show Rationale to Students** - Toggle to display the rationale for the answer to the student. This guidance information will be shown to students after they have submitted their answer and any time they view the assignment after marking it as completed. You can set when to show this selecting from **Never**, **After x attempts**, **If score is greater than or equal to a % of the total** or **Always**
46+
- **Rationale** - Enter guidance for the assessment. This is always visible to the teacher when the project is opened in the course or when opening the student's project.
47+
- **Use Maximum Score** - Toggle to enable assessment final score to be the highest score attained of all runs.
5248

53-
6. Click **Create** to complete the process.
49+
4. Click **Create** to complete the process.
5450

5551

5652
See a Working Example

source/instructors/authoring/assessments/fill-in-blanks.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,4 @@ Examples of regular expressions supported for blank fields:
9595
- **Rationale** - Enter guidance for the assessment. This is always visible to the teacher when the project is opened in the course or when opening the student's project.
9696
- **Use maximum score** - Toggle to enable assessment final score to be the highest score attained of all runs.
9797

98-
4. **(Optional)** Complete **Metadata**.
99-
100-
5. **(Optional)** Complete **Files**.
101-
102-
6. Click **Create** to complete the process.
98+
4. Click **Create** to complete the process.

source/instructors/authoring/assessments/free-text.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,7 @@ Follow these steps to set up a free text assessment manually. For more informati
5151

5252
- **Rationale** - Enter guidance for the assessment. This is visible to the teacher when the project is opened in the course or when viewing the student's project. It can also be shown to students after submission or when they revisit the assignment after marking it as completed.
5353

54-
3. **(Optional)** Complete **Metadata**.
55-
56-
4. **(Optional)** Complete **Files**.
57-
58-
5. Click **Create** to complete the process.
54+
3. Click **Create** to complete the process.
5955

6056

6157
Grading Free Text Assessments

source/instructors/authoring/assessments/grade-book.rst

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,51 +5,39 @@
55

66
Grade Book
77
==========
8-
A Grade Book assessment may be used to manually grade assignments, it will not appear in the student guides. When the instructor opens a student assignment, the Grade Book is available for rubric based grading. Comments, points, and rubric items are visible to the student when the assessment is graded and the grades are released. Grade Book assessments do not show in the total assessment count on student/teacher dashboard.
8+
A Grade Book assessment may be used to manually grade assignments, it will not appear in the student guides. When the instructor opens a student assignment, the Grade Book is available for rubric based grading. Comments, points, and rubric items are visible to the student when the assessment is graded and the grades are released. Grade Book assessments do not show in the total assessment count on student/teacher dashboard. For more information on **General**, **Metadata** (optional) and **Files** (optional) see :ref:`Assessments <assessments>`.
99

10-
1. On the **General** page, enter a short **Name** that describes the test. This name is displayed in the teacher dashboard and when the teacher is viewing the student work. The name should reflect the challenge and thereby be clear when reviewing.
1110

12-
Leaving the name visible will make it easier to locate when grading and we do not recommend toggling the **Show Name** setting to disable it.
13-
14-
.. image:: /img/guides/assessment_gradebook_general.png
15-
:alt: General
11+
1. Complete **General**. Keep the **Show Name** setting enabled to make submissions easier to locate when grading.
1612

1713

1814
2. Click **Grading** in the navigation pane and complete the following fields:
1915

20-
.. image:: /img/guides/assessment_gradebook_grading.png
21-
:alt: Grading
16+
.. image:: /img/guides/assessment_gradebook_grading.png
17+
:alt: Grading
2218

23-
- **Points** - Enter the score if the student selects the correct answer. You can choose any positive numeric value. If this is an ungraded assessment, enter zero (0).
19+
- **Points** - Enter the score if the student selects the correct answer. You can choose any positive numeric value. If this is an ungraded assessment, enter zero (0).
2420

25-
- **Allow Partial Points** - Partial points must be toggled on for this type of assessment. Once you toggle this on, you will be able to add rubric items. Rubric items are negative points, they will be subtracted from the total score of the assessment.
21+
- **Allow Partial Points** - Partial points must be toggled on for this type of assessment. Once you toggle this on, you will be able to add rubric items. Rubric items are negative points, they will be subtracted from the total score of the assessment.
2622

2723
.. image:: /img/guides/assessment_gb_rubric.png
2824
:alt: Rubric
25+
:width: 350px
2926

3027

31-
3. Click **Metadata** in the left navigation pane and complete the following fields:
32-
33-
.. image:: /img/guides/assessment_metadata.png
34-
:alt: Metadata
35-
36-
- **Bloom's Level** - Click the drop-down and choose the level of Bloom's Taxonomy: https://cft.vanderbilt.edu/guides-sub-pages/blooms-taxonomy/ for the current assessment.
37-
- **Learning Objectives** specific educational goal of the current assessment. Typically, objectives begin with Students Will Be Able To (SWBAT). For example, if an assessment asks the student to predict the output of a recursive code segment, then its Learning Objectives could be *SWBAT follow the flow of recursive execution*.
38-
- **Tags** - By default, **Content** and **Programming Language** tags are provided and required. To add another tag, click **Add Tag** and enter the name and values.
39-
40-
4. Click **Files** in the left navigation pane and check the check boxes for additional external files to be included with the assessment. The files are then included in the **Additional content** list.
28+
3. Click **Create** to complete the process.
4129

42-
.. image:: /img/guides/assessment_files.png
43-
:alt: Files
4430

45-
5. Click **Save** to complete the process.
31+
Grading a Grade Book Assessment
32+
-------------------------------
4633

47-
The instructor must :ref:`opening a student assignment <viewing-student-work>` to complete the Grade Book grading. Locate the Grade Book assessment in the student file and click **Grade**.
34+
The instructor must :ref:`open a student assignment <viewing-student-work>` to complete the Grade Book grading. Locate the Grade Book assessment in the student file and click **Grade**.
4835

49-
.. image:: /img/guides/assessment_gb_opengb.png
50-
:alt: Grade book assessment
36+
.. image:: /img/guides/assessment_gb_opengb.png
37+
:alt: Grade book assessment
5138

5239
Click on the 0 or 1 to allocate initial points for overall correctness and then use the other rubric items to subtract points for missing items. There is also a **Points adjust** field if you wish to adjust total points upwards.
5340

54-
.. image:: /img/guides/assessment_gb_grade.png
55-
:alt: Grade book assessment
41+
.. image:: /img/guides/assessment_gb_grade.png
42+
:alt: Grade book assessment
43+
:width: 700px

source/instructors/authoring/assessments/math-assessments.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ Math Assessments
1010
Codio allows you to set and grade math questions for any type and level of mathematics using the **Free Text** assessment. We only offer manual grading of mathematical expressions or proofs.
1111

1212

13-
Manually graded assessments using free text
14-
*******************************************
13+
Manually Graded Assessments Using Free Text
14+
-------------------------------------------
1515

16-
To create a manually graded math question, you can use the **Free text** assessment type. This allows the students to enter expressions or even full proofs and worked answers using Latex. For more information about Latex, please :ref:`click here <latex>`.
16+
To create a manually graded math question, you can use the **Free text** assessment type. This allows the students to enter expressions or even full proofs and worked answers using LaTeX. For more information about LaTeX, see :ref:`LaTeX <latex>`.
1717

18-
You can enter Latex in the **Question** and **Rationale** fields.
18+
You can enter LaTex in the **Question** and **Rationale** fields.
1919

20-
You should also set the **Preview type** drop down to either **Plaintext + Latex** or **Markdown + Latex**. Both of these ensure that the student sees a preview pane beneath their answer entry fully rendered in markdown and/or Latex. Please - :ref:`click here <free-text>` to review the free text assessment.
20+
You should also set the **Preview type** dropdown to either **Plaintext + LaTeX** or **Markdown + LaTeX**. Both of these ensure that the student sees a preview pane beneath their answer entry fully rendered in markdown and/or LaTeX. See :ref:`Free text assessments <free-text>` for more information.
2121

22-
Multiple choice
23-
***************
22+
Multiple Choice
23+
---------------
2424

25-
You can also use the multiple choice assessment type to create answers containing properly rendered Latex expressions.
25+
You can also use the multiple choice assessment type to create answers containing properly rendered LaTeX expressions. See :ref:`Multiple Choice <multiple-choice>` for more information.

0 commit comments

Comments
 (0)