Skip to content

Commit 3a37f15

Browse files
authored
Assessment Library Update (#437)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized and expanded Assessments Library guides into clearer stepwise and tabbed workflows (add/update/unlink) * Renamed and restructured "Add Questions" guidance for clarity, layout, tagging, and dependency handling * Expanded Global and Search docs with filter categories, saved-search management, examples, and workflow updates * Added/updated illustrative images and captions for key steps * Removed the Organization Assessments Library link from Organization settings navigation <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent dcebb92 commit 3a37f15

11 files changed

Lines changed: 217 additions & 91 deletions

source/img/DisconnectFromlib.png

40.5 KB
Loading

source/img/UpdateInLib.png

-46.4 KB
Binary file not shown.

source/img/guides/UpdateInLib.png

93.8 KB
Loading
65.6 KB
Loading

source/instructors/admin/organization/organisation.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Organization settings
1818
enable-custom-script
1919
grade-templates
2020
remove-org-members
21-
create-org-library
2221
public-private-settings
2322
gigabox-usage
2423
delete-org

source/instructors/setupcourses/library/add-questions-to-library.rst

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,37 @@
33

44
.. _add-questions-to-library:
55

6-
Add Questions to an Assessments Library
7-
=======================================
8-
Once an assessment is added to an assessment library, it can be accessed later and added to a project or course.
6+
Add Questions to an Assessment Library
7+
======================================
98

10-
**Prerequisite:**
11-
Before you can add questions to an assessment library, an Admin in your organization must create an organization assessments library. See :ref:`Create an Organization Assessments Library <org-library>` for more information.
9+
You can add assessments to a library to reuse them across multiple projects and courses.
1210

13-
Follow these steps to add questions to your assessments library:
1411

15-
1. Create the assessment (see :ref:`Add a New Assessment <add-assessment>`) for the assignment and be sure to keep the following in mind:
12+
.. important:: Before you can add questions to an assessment library, an Admin in your organization must create an organization assessments library. See :ref:`Create an Organization Assessments Library <org-library>` for more information.
1613

17-
- Assessments on pages set to the :ref:`*1 Panel without tree* layout <layout>` are saved with a :ref:`simple layout <add-questions-from-library>`.
14+
How to Add Questions to a Library
15+
---------------------------------
1816

19-
- Use the **Metadata** tab to tag your assessment so it appears when the :ref:`searching the assessments library <search-library>`.
17+
1. Create the assessment (see :ref:`Add a New Assessment <add-assessment>`). Keep the following in mind:
18+
19+
**Layout considerations:**
20+
21+
- Assessments on pages using the :ref:`1 Panel without tree layout <layout>` are saved with a :ref:`simple layout <add-questions-from-library>`.
22+
23+
**Tagging for searchability:**
24+
25+
- Use the **Metadata** tab to tag your assessment so it appears when :ref:`searching the assessments library <search-library>`.
26+
27+
**Including dependencies:**
28+
29+
- Use the **Files** tab to include all dependent files (grading scripts, images, etc.) so the assessment works properly when added from the library.
2030

21-
- Use the **Files** tab to ensure all dependent files, such as grading scripts, images used in the guides pane, etc. are associated with the assessment so it works properly when added from the library.
2231

2332
2. Once the assessment is created, click **Save in Library** in the lower right corner on the assessment page.
2433

2534
.. image:: /img/guides/assessment-save-to-library.png
2635
:alt: Save in Library
36+
:width: 450px
2737

2838
3. On the **Select Library** dialog, choose the library from the drop-down list.
2939

@@ -35,6 +45,6 @@ Follow these steps to add questions to your assessments library:
3545
.. image:: /img/guides/assessment-library-selection.png
3646
:alt: Select Library
3747

38-
If you receive an error message, ensure that you have write access to your organization's assessment library. See :ref:`Create an Organization Assessments Library <org-library>` for more information.
48+
.. warning:: If you receive an error message, ensure that you have write access to your organization's assessment library. See :ref:`Create an Organization Assessments Library <org-library>` for more information.
3949

4050
5. Once a question has been added, follow the steps in :ref:`Update an Existing Assessment from Library <update-library>` to update your assessment with the newly added question.

source/instructors/setupcourses/library/assessmentslibrary.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Assessments Libraries
1111
:hidden:
1212

1313
global-library
14+
../../admin/organization/create-org-library
1415
search-library
1516
add-questions-from-library
1617
add-questions-to-library
@@ -24,7 +25,3 @@ You can also use the assessment libraries with the :ref:`Random Assessment <rand
2425

2526
You can organize your library by course number, programming language, department, etc. and filter the library based on tags when searching for assessments.
2627

27-
28-
29-
30-

source/instructors/setupcourses/library/global-library.rst

Lines changed: 67 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,90 @@
44
.. _global-library:
55

66
Codio Global Assessments Library
7-
================================
8-
The Global Assessments Library is an assessment library to which all Codio users have *read-only* access. The library contains auto-graded assessment questions that cover a wide variety of topics, difficulties, and assessment types. We are currently populating it with assessments in:
7+
=================================
8+
9+
The Global Assessments Library is an assessment library to which all Codio users have **read-only access**. The library contains auto-graded assessment questions that cover a wide variety of topics, difficulties, and assessment types.
10+
11+
Current Coverage
12+
----------------
13+
14+
We are currently populating it with assessments in:
915

1016
- Java
1117
- C / C++
1218
- Python
1319
- JavaScript
1420
- Data Structures (in Java)
1521

16-
All assessments in the global library are auto-graded, contain example solutions and answer explanations for the student, and some include teacher notes to help better convey the intended learning objective of the assessment.
22+
Assessment Features
23+
-------------------
24+
25+
All assessments in the global library are auto-graded and contain example solutions and answer explanations for students. Some assessments also include teacher notes to help better convey the intended learning objective.
26+
1727

1828
Using the Global Assessments Library
1929
------------------------------------
30+
2031
To access the Codio Global Assessments Library, follow these steps:
2132

22-
1. Click the **Assessments** button and choose **Assessment** from the **Add from Library** area
23-
2. On the **Choose an Assessment to Add** dialog, click the **Library Name** drop-down and choose **Codio Main**.
24-
3. You can filter through the different assessments by tags:
33+
1. From the course dashboard navigate to **Edit Assignments**.
34+
2. Click and Open an Assignment.
35+
3. Click **Edit**.
36+
4. Click the **Assessments** button and choose **Assessment** from the **Add from Library** section.
37+
5. On the **Choose an Assessment to Add** dialog, click the **Library Name** drop-down and choose **Codio Main**.
38+
6. You can filter through the different assessments by tags:
2539

26-
.. image:: /img/bloomsTax.png
27-
:alt: Bloom's Taxonomy
40+
.. image:: /img/bloomsTax.png
41+
:alt: Bloom's Taxonomy
42+
:width: 650px
2843

29-
- Programming language
30-
- Assessment type (auto-detected)
31-
- Category (topic-level)
32-
- Content (sub-topic level)
33-
- Learning Objective (in SWBAT form - "Students will be able to....")
34-
- Bloom's Taxonomy level
44+
45+
.. list-table:: Filter Categories and Inputs
46+
:widths: 30 70
47+
:header-rows: 1
48+
49+
* - Category
50+
- Available Inputs & Description
51+
* - Bloom's Taxonomy Level
52+
- Level I - Remembering
53+
54+
Level II - Understanding
55+
56+
Level III - Applying
57+
58+
Level IV - Analyzing
59+
60+
Level V - Evaluating
61+
62+
Level VI - Creating
63+
* - Assessment Type (auto-detected)
64+
- Standard Code Test
65+
66+
Advanced Code Test
67+
68+
Parsons Puzzle
69+
70+
Multiple Choice
71+
72+
Fill in the Blanks
73+
74+
Free Text Autograde
75+
* - Programming Language
76+
- Select the programming language for code-based assessments (e.g., Python, Java, C++, JavaScript)
77+
* - Category (topic-level)
78+
- Broad subject area or topic category for filtering assessments (e.g., variables, functions, loops)
79+
* - Content (sub-topic level)
80+
- Specific subtopic or concept within the category (e.g., modifying variables, creating functions, nesting for loops)
81+
* - Learning Objective (SWBAT form)
82+
- Define what "Students Will Be Able To..." accomplish after completing the assessment
83+
84+
Example: "Students will be able to implement binary search algorithms efficiently"
85+
3586

3687
4. Once you find the question you want to add to your assessment, click **Add**.
3788

38-
Modify question from Global Assessment Library
89+
Modify Question from Global Assessment Library
3990
----------------------------------------------
4091
If you like a question in the Assessments Library but want to modify it, :ref:`unlink <unlink-assessment>` the question from the library and then modify it for your assignment.
4192

42-
You can then add your new version of the assessment to your organization's assessment library.
93+
You can then add your new version of the assessment to your organization's assessment library. For more information on creating an organization assessments library see :ref:`Organization Assessments Library <org-library>`.

source/instructors/setupcourses/library/search-library.rst

Lines changed: 83 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -5,71 +5,115 @@
55
Search Assessments Library
66
==========================
77

8-
You search an assessment library the same whether you are using Codio's :ref:`Global Assessment Library <global-library>` or your :ref:`organization assessment library <org-library>`. Follow these steps to search a library:
8+
Searching an assessment library works the same way whether you're using Codio's :ref:`Global Assessment Library <global-library>` or your :ref:`organization assessment library <org-library>`. To search a library, follow these steps:
99

10-
1. In the Guide Editor, click the **Assessments** button and choose **Assessment** from the **Add from Library** area.
10+
1. From the course dashboard navigate to **Edit Assignments**.
11+
12+
2. Click and Open an Assignment.
13+
14+
3. Click **Edit**.
15+
16+
4. In the Guide Editor, click the **Assessments** button and choose **Assessment** from the **Add from Library** area.
1117

12-
2. Click the **Library Name** drop-down and choose the assessments library you want to search.
18+
5. Click the **Library Name** drop-down and choose the assessments library you want to search.
1319

1420
.. image:: /img/selectLib.png
1521
:alt: Select Library
1622

17-
3. To narrow the assessments that are displayed, enter a tag and value pair. For example, you can search by the **Programming Language** (tag) and indicate you want **Python** (value) questions. The search is not case sensitive and Codio presents auto-complete suggestions as you type.
23+
24+
6. To narrow the displayed assessments, enter a tag and value pair. For example, select **Programming Language** as the tag and **Python** as the value. The search is not case sensitive, and Codio provides auto-complete suggestions as you type.
1825

1926
.. image:: /img/autoComplete.png
2027
:alt: Autocomplete
2128

22-
You can also click any of the tag fields in the results to automatically filter and add a new row (click +) to your search query. You can add as many tag:value pairs as needed to narrow your search.
2329

24-
.. image:: /img/doubleTags.png
25-
:alt: Add Tags
30+
.. tab-set::
31+
32+
.. tab-item:: Filter Categories
33+
34+
.. list-table:: Filter Categories and Inputs
35+
:widths: 30 70
36+
:header-rows: 1
37+
38+
* - Category
39+
- Available Inputs & Description
40+
* - Bloom's Taxonomy Level
41+
- Level I - Remembering
42+
43+
Level II - Understanding
44+
45+
Level III - Applying
46+
47+
Level IV - Analyzing
48+
49+
Level V - Evaluating
50+
51+
Level VI - Creating
52+
* - Assessment Type (auto-detected)
53+
- Standard Code Test
54+
55+
Advanced Code Test
56+
57+
Parsons Puzzle
58+
59+
Multiple Choice
60+
61+
Fill in the Blanks
62+
63+
Free Text Autograde
64+
* - Programming Language
65+
- Select the programming language for code-based assessments (e.g., Python, Java, C++, JavaScript)
66+
* - Category (topic-level)
67+
- Broad subject area or topic category for filtering assessments (e.g., variables, functions, loops)
68+
* - Content (sub-topic level)
69+
- Specific subtopic or concept within the category (e.g., modifying variables, creating functions, nesting for loops)
70+
* - Learning Objective (SWBAT form)
71+
- Define what "Students Will Be Able To..." accomplish after completing the assessment
72+
73+
Example: "Students will be able to implement binary search algorithms efficiently"
74+
75+
.. tab-item:: Using Multiple Filters
2676

27-
Once you have completed entering tag and value pairs, the results are displayed.
77+
**Adding multiple filters:**
78+
79+
- Click any tag field in the results to automatically add it to your search query
80+
- Click the **+** button to add a new row for additional tag and value pairs
81+
- Add as many tag and value pairs as needed to refine your search
2882

29-
.. image:: /img/searchResults.png
30-
:alt: Search Results
83+
.. image:: /img/doubleTags.png
84+
:alt: Add Tags
3185

32-
4. Scroll through the search results using the scroll bar or use the navigation buttons in the upper portion of the page to move forward, back, or to a specific page.
86+
The results update automatically based on your selected filters.
3387

34-
.. image:: /img/scrollThrough.png
35-
:alt: Scroll Results
88+
.. image:: /img/searchResults.png
89+
:alt: Search Results
3690

37-
5. Click an assessment to preview the question.
3891

39-
.. image:: /img/previewQuestion1.png
40-
:alt: Preview Question
92+
Managing Saved Searches
93+
-----------------------
4194

42-
If you preview a second question, the first preview collapses.
95+
.. tab-set::
4396

44-
.. image:: /img/previewQuestion2.png
45-
:alt: Preview Collapsed
97+
.. tab-item:: Saving Searches
4698

47-
Saving searches
48-
---------------
49-
If you want to save search parameters, follow these steps:
99+
If you want to save search parameters, follow these steps:
50100

51-
1. Click the **Save** button to the right of the tags and values.
101+
1. Click the **Save** button to the right of the tags and values.
52102

53-
.. image: /img/doubleTags2.png
54-
:alt: Save Search
103+
2. On the **Save Search** dialog, enter a **Search Name** and click **OK**.
55104

56-
2. On the **Save Search** dialog, enter a **Search Name** and click **OK**.
105+
.. image:: /img/nameSearch.png
106+
:alt: Search Name
57107

58-
.. image:: /img/nameSearch.png
59-
:alt: Search Name
108+
.. tab-item:: Using Saved Searches
60109

61-
Using saved searches
62-
--------------------
63-
To use a saved search, click the **Saved** drop-down list and choose the saved search.
110+
To use a saved search, click the **Saved** drop-down list and choose the saved search.
64111

65-
.. image: /img/savedSearch.png
66-
:alt: Use Saved Search
112+
You can edit these search parameters without changing your saved search.
67113

68-
You can edit these search parameters without changing your saved search.
114+
.. tab-item:: Deleting Saved Searches
69115

70-
Delete saved searches
71-
---------------------
72-
To remove a saved search, click the **Saved** drop-down list and click the red **x** to the name.
116+
To remove a saved search, click the **Saved** drop-down list and click the red **x** next to the name.
73117

74-
.. image:: /img/savedSearchDelete.png
75-
:alt: Delete Saved Search
118+
.. image:: /img/savedSearchDelete.png
119+
:alt: Delete Saved Search

source/instructors/setupcourses/library/unlink-assessment.rst

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,39 @@
55

66
Unlink an Assessment
77
====================
8-
If you want to modify an assessment that is in the library, you can unlink it, make your changes, and then add your own version to your organization's assessments library. Follow these steps to find the assessment you wish to modify, either:
98

10-
1. In the Guide Editor, click the **Edit: <Assessment Name>** button to the right of the assesment.
9+
To modify a library assessment, you must first unlink it from the library. After making changes, you can add your modified version to your organization's assessment library.
1110

12-
.. image:: /img/guides/editassessmentbutton.png
13-
:alt: Edit Assessment
1411

15-
Or
12+
Unlink Process
13+
--------------
1614

17-
2. Click the **Assessment** button to view the list of all assessments and click the assessment to open it.
15+
1. Choose one of the following methods to find the assessment you want to modify:
1816

19-
.. image:: /img/guides/editassessmentlist.png
20-
:alt: Edit Assessment List
17+
.. tab-set::
2118

22-
3. To unlink the assessment, open the assessment,
19+
.. tab-item:: From the Guide Editor
2320

24-
4. Click **Disconnect** in the lower right corner.
21+
Click the **Edit: <Assessment Name>** button to the right of the assessment.
22+
23+
.. image:: /img/guides/editassessmentbutton.png
24+
:alt: Edit Assessment
25+
:width: 450px
26+
27+
.. tab-item:: From the Assessment List
28+
29+
Click the **Assessment** button to view all assessments, then click the assessment to open it.
30+
31+
.. image:: /img/guides/editassessmentlist.png
32+
:alt: Edit Assessment List
33+
34+
35+
2. To unlink the assessment, open the assessment.
36+
37+
3. Click **Disconnect** in the lower right corner.
2538

2639
.. image:: /img/DisconnectFromlib.png
2740
:alt: Disconnect
41+
:width: 450px
2842

2943
A message is displayed confirming that the assessment has been successfully disconnected from the appropriate library.

0 commit comments

Comments
 (0)