Skip to content

Commit

Permalink
Merge pull request #849 Reorganize Components and Activities docs aft…
Browse files Browse the repository at this point in the history
…er migration

Retitle according to diataxis standards and user behavior (e.g. How-to's start with action verb)
Consolidate redundant docs
Improve navigation
  • Loading branch information
sarina authored Mar 1, 2025
2 parents 43fe1f1 + 7588dda commit 468a889
Show file tree
Hide file tree
Showing 134 changed files with 1,829 additions and 2,001 deletions.
2 changes: 1 addition & 1 deletion source/community/release_notes/dogwood.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ uploads, the following options are available.

* A custom set of one or more file formats, specified by the course team.

For more information, see PA Allow Images.
For more information, see Allow ORA Images.

To protect learners from the transmission of potentially harmful files, this
enhancement also gives system administrators the ability to configure a list of
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ ways to extend the platform, starting with the following table.
- Yes
* - Clean UI Integration
- Yes
- No (see :ref:`LTI Component`)
- No (see :ref:`About the LTI Component`)
- Yes
- Yes
- Yes
Expand All @@ -72,13 +72,13 @@ ways to extend the platform, starting with the following table.
- Yes
- Yes
* - Server Side Grading
- Possibly (See :ref:`Custom JavaScript`)
- Possibly (See :ref:`Custom JavaScript<Guide to Custom JavaScript Display and Grading Problem>`)
- Yes
- Yes
- Yes
- Yes
* - Usage Data
- No (See :ref:`Custom JavaScript`)
- No (See :ref:`Custom JavaScript<Guide to Custom JavaScript Display and Grading Problem>`)
- No
- Limited
- Yes
Expand Down
6 changes: 2 additions & 4 deletions source/developers/references/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -518,11 +518,9 @@ Glossary
Rubric

A list of the items that a learner's response should cover in an open
response assessment. For more information, see the
`partnercoursestaff:PA Rubric` topic in `partnercoursestaff:Open
Response Assessments Two`.
response assessment.

See also :ref:`Open Response Assessment<Open Response Assessment_g>`.
See :ref:`Open Response Assessment<Open Response Assessment_g>`.

Seat Type

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Android and iPhone apps, although we still recommend that learners complete
graded assignments on a desktop computer, depending on the type of assessments
that their courses include. For information on which exercises and tools are
mobile-ready, see the table in the :ref:`Introduction to Exercises and
Tools<Create Exercises>` section.
Tools<About Problems Exercises and Tools>` section.

To make the course experience for mobile learners as rewarding as it is for
learners using desktop computers, keep the following best practices in mind as
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _Timed Exams:

Timed Exams
#############
About Timed Exams
#################

.. tags:: educator, concept

Expand All @@ -25,7 +25,7 @@ starting a timed exam.
.. seealso::


:ref:`Configure Timed Exams`
:ref:`Manage Timed Exams`



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Using Open edX as an LTI Tool Provider
.. tags:: educator, concept

You can also include content from an LTI provider in your courses. For more
information, see :ref:`LTI Component`.
information, see :ref:`About the LTI Component`.

.. _Grading Remote Content:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
.. _Open Response Assessments:

Introduction to Open Response Assessments
About Open Response Assessments (ORA)
#########################################

.. tags:: educator, concept

.. contents::
:local:
:depth: 2

In open response assessments (ORA), learners submit essay responses and then go
through a series of assessment steps (such as peer assessment and self
assessment) to complete the assignment.
Expand All @@ -23,29 +27,29 @@ assessment) to complete the assignment.
The following topics provide conceptual information about open response
assessments.

* :ref:`PA Elements`
* :ref:`Elements of an Open Response Assessment`
* :ref:`PA Scoring`
* :ref:`Best Practices for ORA`

For information about creating and managing open response assessments,
including step by step instructions, see the following sections.

* :ref:`PA Create an ORA Assignment`
* :ref:`Create an ORA Assignment`
* :ref:`Managing ORA Assignments`
* :ref:`Accessing ORA Assignment Information`
* :ref:`Access ORA Assignment Information`


.. _PA Elements:
.. _Elements of an Open Response Assessment:

Elements of an Open Response Assessment
***************************************

When you create an open response assessment assignment, you include several
elements.

* One or more :ref:`prompts <PA Prompts>`, or questions, that learners answer.
* One or more :ref:`prompts <ORA Prompts>`, or questions, that learners answer.

* A :ref:`rubric <PA Rubric>`. One rubric is used to grade all the prompts in
* A :ref:`rubric <ORA Rubrics>`. One rubric is used to grade all the prompts in
the assessment.

* One or more :ref:`assessment steps <PA Assessment Steps>`. Assignments can
Expand All @@ -58,9 +62,9 @@ elements.
be the final step in the assignment.

For step-by-step instructions for creating an open response assessment, see
:ref:`PA Create an ORA Assignment`.
:ref:`Create an ORA Assignment`.

.. _PA Prompts:
.. _ORA Prompts:

Prompts
=======
Expand All @@ -73,15 +77,14 @@ other type of file to accompany their written response.
Within each prompt, you can include helpful information for your learners,
such as the approximate number of words or sentences that their responses
should have, the types of files that they can upload, or what they can expect
after they submit their responses. For more information, see :ref:`PA Add
Prompt`.
after they submit their responses. For more information, see :ref:`Add ORA Prompt`.

In the learner view of the assignment, each prompt appears above the field
where learners enter their responses. For more information, see
:ref:`PA Assessment Steps`.


.. _PA Rubric:
.. _ORA Rubrics:

Rubric
=======
Expand Down Expand Up @@ -131,7 +134,7 @@ A rubric consists of several criteria and a set of options for each criterion.

You can also include criteria that do not have options, but that do include
a field where learners or staff can enter feedback. For more information,
see :ref:`PA Criteria Comment Field Only`.
see :ref:`ORA Criteria Comment Field Only`.


In a rubric as it appears to a learner, the following elements are visible.
Expand All @@ -151,11 +154,11 @@ Criterion names do not display in the rubric that learners use to perform
their assessments, but do appear on the page that shows the learner's final
ORA assignment grade.

For information about creating a rubric, see :ref:`PA Add Rubric`.
For information about creating a rubric, see :ref:`Add ORA Rubric`.


An Example Criterion
********************
------------------------

In a rubric, one criterion and its set of options might resemble the
following.
Expand Down Expand Up @@ -228,7 +231,7 @@ a self assessment ("Assess Your Response").
.. _PA Student Training Step:

Learner Training Step
*********************
----------------------

Learner training steps teach learners to perform their own assessments. A
learner training assessment contains one or more sample responses that you
Expand Down Expand Up @@ -268,7 +271,7 @@ For more information, see :ref:`PA Student Training`.
.. _Peer Assessment Step:

Peer Assessment Step
********************
--------------------

In the peer assessment step, learners review the responses of other learners
in the course. For each response, they select an option for each criterion in
Expand All @@ -282,7 +285,7 @@ For information about how peer assessments affect a learner's assignment grade,
see :ref:`PA Scoring`.

Number of Responses and Assessments
===================================
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When you include a peer assessment step, you specify the number of responses
that each learner must assess (**Must Grade**) and the number of peer
Expand All @@ -307,7 +310,7 @@ do not count toward the score that the response receives.
.. _Feedback Options:

Feedback Options
================
-----------------

By default, in peer assessment steps, learners can provide text feedback for
the entire response, using a single comment field below the entire rubric. You
Expand All @@ -317,12 +320,12 @@ individual criteria. This comment field can contain up to 1000 characters.
Comment fields for individual criterion appear below the options for the
criterion.

For more information, see :ref:`PA Add Rubric` and :ref:`PA Criteria Comment
For more information, see :ref:`Add ORA Rubric` and :ref:`ORA Criteria Comment
Field Only`.


Assessing Additional Responses
==============================
-------------------------------

Learners can assess more than the required number of responses. After a
learner completes the peer assessment step, the step "collapses" so that only
Expand All @@ -335,7 +338,7 @@ peer assessments.
.. _Self Assessment Step:

Self Assessment Step
********************
---------------------

In self assessment steps, the learner sees her own response followed by the rubric.
As with peer assessments, the learner evaluates the response using the rubric,
Expand All @@ -347,7 +350,7 @@ include the peer assessment before the self assessment.
.. _Staff Assessment Step:

Staff Assessment Step
*********************
---------------------

In staff assessment steps, a member of the course team performs an evaluation
of the learner's response. Course team members grade the response using the
Expand Down Expand Up @@ -500,6 +503,9 @@ Then set the toggle for this feature on or off
:alt: Image highlighting the toggle for flexible peer grading on the course level
:width: 600

Scoring Calculation
********************

Self Assessment Scoring
=======================

Expand Down Expand Up @@ -550,7 +556,7 @@ prevent the page from becoming too long.
learner response from peer grading>` it is also removed from the **Top
Responses** list.

For more information, see :ref:`PA Show Top Responses`.
For more information, see :ref:`ORA Show Top Responses`.

.. _Best Practices for ORA:

Expand Down Expand Up @@ -592,7 +598,7 @@ Designing the Assignment
Grading and Rubrics
===================

* Make sure you have a well designed and clear :ref:`rubric <PA Rubric>` for
* Make sure you have a well designed and clear :ref:`rubric <ORA Rubrics>` for
the assignment. A good rubric is very important in helping to eliminate
ambiguity in the peer grading process.

Expand Down Expand Up @@ -673,7 +679,7 @@ responses, however, be aware of the following limitations and best practices.

* Image files must be in .jpg, .gif, or .png format.

For more information, see :ref:`PA Allow Images`.
For more information, see :ref:`Allow ORA Images`.

.. _Prohibited File Extensions:

Expand Down Expand Up @@ -705,15 +711,14 @@ information, see `Configuring ora2 to prohibit submission of file types`_.
.vbscript, .workflow .ws, .wsc, .wsf, .wsh

.. seealso::


:ref:`PA Create an ORA Assignment` (how-to)
:ref:`Create an ORA Assignment` (how-to)

:ref:`Managing ORA Assignments` (how-to)

:ref:`ORA Staff Grading` (reference)

:ref:`Accessing ORA Assignment Information` (reference)
:ref:`Access ORA Assignment Information` (reference)


**Maintenance chart**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,40 +1,34 @@
.. _Write Your Own Grader:
.. _About Custom Python-Evaluated Input Problem:

Custom Python-evaluated Input Problem (Write Your Own Grader)
About Custom Python-evaluated Input Problem
#############################################################

.. tags:: educator, reference
.. tags:: educator, concept

In custom Python-evaluated input (also called "write-your-own-grader"
problems), the grader uses a Python script that you create and embed in the
problem to evaluate a learner's response or provide hints. These problems can
be any type. :ref:`Numerical input<Numerical Input>` and :ref:`text input<Text
be any type. :ref:`Numerical input<About Numerical Input>` and :ref:`text input<Text
Input>` problems are the most common write-your-own-grader problems.

Custom Python-evaluated input problems can include the following advanced
problem types.

* :ref:`Chemical Equation`
* :ref:`Custom JavaScript`
* :ref:`Custom JavaScript<Guide to Custom JavaScript Display and Grading Problem>`
* :ref:`Gene Explorer`
* :ref:`Protein Builder`


Learn here how to :ref:`Create a Custom Python Evaluated Input Problem in Studio`, and visit :ref:`Award Partial Credit` to learn how to configurate the credits in this type of exercise.
Learn here how to :ref:`Create a Custom Python Evaluated Input Problem`, and visit :ref:`Award Partial Credit` to learn how to configurate the credits in this type of exercise.


.. seealso::


:ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to)
:ref:`Create a Custom Python Evaluated Input Problem` (how to)

:ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format` (how to)

:ref:`Create a Randomized Custom Python Evaluated Input Problem` (how to)

:ref:`Script Tag Format` (concept)

:ref:`Award Partial Credit` (concept)
:ref:`Guide to the Custom Python-Evaluated Input Problem` (concept)


**Maintenance chart**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _drag_and_drop_problem:
.. _About the Drag and Drop Problem:

Drag and Drop Problem
#####################
About the Drag and Drop Problem
###############################

.. tags:: educator, concept

Expand All @@ -18,7 +18,7 @@ to use drag and drop problems in your course.
drag and drop problem type. This drag and drop problem type includes
significant improvements and you should use it for any new course
development. For more information about the previous, deprecated drag and
drop problem type, see :ref:`Drag and Drop`.
drop problem type, see :ref:`Guide to the Drag and Drop Problem`.

.. _overview_of_drag_and_drop_problems:

Expand Down Expand Up @@ -95,9 +95,9 @@ message informs the learner that the problem is complete.
.. seealso::


:ref:`Creating a Drag and Drop Problem` (how-to)
:ref:`Create a Drag and Drop Problem` (how-to)

:ref:`Drag and Drop` (reference)
:ref:`Guide to the Drag and Drop Problem` (reference)


**Maintenance chart**
Expand Down
Loading

0 comments on commit 468a889

Please sign in to comment.