From 678056d470baf46628d7a4f510be5d725f51e078 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Thu, 25 Jun 2015 12:23:46 -0400 Subject: [PATCH] Updated text for Current Enrollment and added Total Enrollment image files may need to be updated --- docs/en_us/dashboard/source/Overview.rst | 4 +- docs/en_us/dashboard/source/Reference.rst | 40 +++++++-------- .../source/engagement/Engagement_Content.rst | 4 +- .../source/enrollment/Demographics_Age.rst | 6 +-- .../source/enrollment/Demographics_Gender.rst | 9 ++-- .../source/enrollment/Enrollment_Activity.rst | 49 +++++++++---------- .../enrollment/Enrollment_Geography.rst | 16 +++--- .../source/front_matter/change_log.rst | 4 ++ 8 files changed, 68 insertions(+), 64 deletions(-) diff --git a/docs/en_us/dashboard/source/Overview.rst b/docs/en_us/dashboard/source/Overview.rst index f7e8e69c1..79cf2b316 100644 --- a/docs/en_us/dashboard/source/Overview.rst +++ b/docs/en_us/dashboard/source/Overview.rst @@ -28,8 +28,8 @@ descriptions, move your cursor over the "i" information icons that appear at top right of each chart or metric. .. image:: images/tip_on_mouseover.png - :alt: The Active Students Last Week metric with the tip "Students who visited - at least one page in the course content" showing. + :alt: The Active Students Last Week metric with the tooltip "Students who + visited at least one page in the course content" showing. This guide is intended to offer more complete information about the data that edX Insights presents. diff --git a/docs/en_us/dashboard/source/Reference.rst b/docs/en_us/dashboard/source/Reference.rst index cec87a818..255d986ec 100644 --- a/docs/en_us/dashboard/source/Reference.rst +++ b/docs/en_us/dashboard/source/Reference.rst @@ -77,17 +77,17 @@ For information about viewing enrollment activity data in edX Insights, see **Enrollment Over Time chart** -* The filled area of this stacked area chart represents the total - number of users enrolled in the course each day. +* The filled area of this stacked area chart represents the + number of users who are currently enrolled in the course each day. * The x-axis shows dates from course creation through the end of the last update period. -* The y-axis shows the total number of enrolled users. +* The y-axis shows the number of currently enrolled users. * For courses that offer more than one enrollment option or certification track, different colors in the filled area represent the contribution of each - option and track to the enrollment total. + option or track to the current enrollment count. In addition to honor code certificates, courses can offer a verified certificate option or enroll students through a professional education @@ -167,9 +167,9 @@ For information about viewing student demographic data in edX Insights, see * Each bar in the histogram represents the percentage of enrolled users (y-axis) who selected a completion level (x-axis). -* Percentages are calculated for the total number of students who reported an - educational level, not from the total number of students enrolled in the - course. +* Percentages are calculated based on the number of currently enrolled students + who reported an educational level, not on the total number of enrolled + students. * The table that follows shows each edX Insights label, the option that students can select at registration, and a brief description. @@ -236,12 +236,12 @@ For information about viewing student demographic data in edX Insights, see who selected each choice (Female, Male, Other). * The chart only includes students who reported their genders. The percentages - shown in the chart are computed for the total number of students who did + shown in the chart are computed for currently enrolled students who did select a gender. -* The report includes all enrolled students. For each day, the report includes - the daily total enrollment count followed by columns that break down the - total by Female, Male, Other or Not Reported. +* The report includes all currently enrolled students. For each day, the report + includes the daily enrollment count followed by columns that break down the + enrollment count by Female, Male, Other, or Not Reported. .. _Location Computations: @@ -266,17 +266,17 @@ For information about viewing geographic data in edX Insights, see **Geographic Distribution map** -* The number of users and the percentage of the total enrollment is provided - for each country. +* The number of users and the percentage of the current course enrollment is + provided for each country. * Users with IP addresses that cannot be located, or that result in a "non- country" code such as A1 (Anonymous Proxy), A2 (Satellite Provider), or O1 (Other Country), are reported in an "Unknown" category. * The computational frequency and approaches used to determine user location - and user enrollment status are different. As a result, you may note - discrepancies between the total number of students reported by the Enrollment - Activity and Enrollment Geography sections of edX Insights. + and user enrollment status are different. As a result, you might note + discrepancies between the current number of students reported by the + Enrollment Activity and Enrollment Geography sections of edX Insights. **Total Countries Represented metric** @@ -562,19 +562,19 @@ that are running now, or that ran recently, than for courses that ran in the past. Not all data for every value reported by edX Insights is available for every course run. -In the following situations, data may not be available in edX Insights. +In the following situations, data might not be available in edX Insights. * EdX changed the method used to track student enrollments on 3 Dec 2013. For courses created in Studio prior to 4 Dec 2013, edX Insights reports enrollment activity beginning with the enrollment count on 11 Nov 2013. * For courses with a very small number of enrolled users, such as newly created - courses, data for enrollment activity, enrollment geography, or both, may not - be available. + courses, data for enrollment activity, enrollment geography, or both, might + not be available. * For courses that do not have any recorded student interactions, such as test courses and courses that finished running early in the history of the edX - platform, data for enrollment activity and student engagement may not be + platform, data for enrollment activity and student engagement might not be available. * Charts are not available for problems that use the **Randomization** setting diff --git a/docs/en_us/dashboard/source/engagement/Engagement_Content.rst b/docs/en_us/dashboard/source/engagement/Engagement_Content.rst index b8ebf2eae..a7f79086c 100644 --- a/docs/en_us/dashboard/source/engagement/Engagement_Content.rst +++ b/docs/en_us/dashboard/source/engagement/Engagement_Content.rst @@ -29,7 +29,7 @@ an overall total for students who completed any type of course activity, and totals for students who clicked play for any course video and for students who submitted an answer for a problem. Each total is for activity completed within a one week period. To see the total count for each activity type for a given -week, move your cursor over the chart to display a tip. +week, move your cursor over the chart to display a tooltip. Activity is included beginning with the week in which the first page visit took place. The first page visit is typically by a member of the course staff @@ -47,7 +47,7 @@ the beta test, the course start date, and the due date of the first homework. In the second example, a small, private online course was developed on one instance of the platform, and then exported and imported to a different -instance just before the course start date. The tip shows the number of +instance just before the course start date. The tooltip shows the number of students enaging in different activities on the same day that the final homework was due. diff --git a/docs/en_us/dashboard/source/enrollment/Demographics_Age.rst b/docs/en_us/dashboard/source/enrollment/Demographics_Age.rst index dc1879d69..0be34f422 100644 --- a/docs/en_us/dashboard/source/enrollment/Demographics_Age.rst +++ b/docs/en_us/dashboard/source/enrollment/Demographics_Age.rst @@ -24,9 +24,9 @@ Descriptions follow; for detailed information about the computations, see Self-Reported Student Age Chart ====================================== -Each bar on this chart represents the total number of enrolled learners who are -a given age, based on reported year of birth. Moving your cursor over a bar in -the chart shows a tip with the number of students of that age. +Each bar on this chart represents the count of currently enrolled learners who +are a given age, based on reported year of birth. Moving your cursor over a bar +in the chart shows a tooltip with the number of students of that age. The chart includes every reported age. This data is also available for review in tabular format and can be downloaded. diff --git a/docs/en_us/dashboard/source/enrollment/Demographics_Gender.rst b/docs/en_us/dashboard/source/enrollment/Demographics_Gender.rst index 08174ade9..1bec84155 100644 --- a/docs/en_us/dashboard/source/enrollment/Demographics_Gender.rst +++ b/docs/en_us/dashboard/source/enrollment/Demographics_Gender.rst @@ -59,10 +59,11 @@ values are computed. Gender Breakdown Over Time Report ====================================== -The daily total enrollment count with gender breakdown is available for review -or download. Columns show each date, the total enrollment on that date, and -breakdown columns for the number of people who reported each gender category -and who did not provide this information at registration. +The daily count of currently enrolled learners, with gender breakdown, is +available for review or download. Columns show each date, the current +enrollment as of that date, and breakdown columns for the number of people who +reported each gender category and who did not provide this information at +registration. To download the Gender Breakdown Over Time report in a comma-separated value file, click **Download CSV**. The CSV file contains the following columns: diff --git a/docs/en_us/dashboard/source/enrollment/Enrollment_Activity.rst b/docs/en_us/dashboard/source/enrollment/Enrollment_Activity.rst index f8b173ed0..7ae3440a5 100644 --- a/docs/en_us/dashboard/source/enrollment/Enrollment_Activity.rst +++ b/docs/en_us/dashboard/source/enrollment/Enrollment_Activity.rst @@ -24,9 +24,9 @@ Daily Student Enrollment Chart ====================================== The daily student enrollment chart is a stacked area chart: the filled area -represents the total number of enrolled learners on a particular date. For -courses that offer more than one enrollment option or track, different colors -represent the number of students who are enrolled with each option. +represents the number of learners enrolled in the course on a particular date. +For courses that offer more than one enrollment option or track, different +colors represent the number of students who were enrolled with each option. The chart currently includes these enrollment options and tracks, if they are offered for your course. @@ -35,18 +35,18 @@ offered for your course. * Verified certificate * Professional education program -Moving your cursor over the chart shows a tool tip with the counts for each -enrollment type, and the total enrollment, for each day. +Moving your cursor over the chart shows a tooltip with the counts for each +enrollment type, and the current enrollment, for each day. The chart includes enrollment data for every day, beginning with the first enrollment (typically of the course creator). This data is also available for review in tabular format and can be downloaded. A couple of examples of this chart follow for different courses. In the first -example, for a MOOC, you see enrollment climb fairly steadily over a period of +example, for a MOOC, you see enrollment climb fairly steadily over a period of several months. The markers begin with two "student" enrollments (almost -certainly the course creator and another staff member) on the day the course -was created in Studio. +certainly the course creator and another course team member) on the day the +course was created in Studio. .. image:: ../images/enrollment_chart.png :alt: A chart with the periods when the rate of enrollment was greater @@ -74,40 +74,39 @@ See the :ref:`Reference` for a detailed description of how enrollment values are determined. ====================================== -Enrollment Metric +Total Enrollment Metric ====================================== -This count reports the total number of students who enrolled in the course, -less any students who unenrolled. +This count reports the number of students who have ever enrolled in the +course. + +====================================== +Current Enrollment Metric +====================================== + +This count reports the number of students who have enrolled in the course, less +any students who have unenrolled. ====================================== Change in Last Week Metric ====================================== -This metric reports the difference between the enrollment total at the +This metric reports the difference between the current enrollment count at the end of the day yesterday and at the end of the day one week ago. ====================================== Verified Enrollment Metric ====================================== -This count reports the total number of enrolled students who have elected to -pursue a verified certificate for the course. - -====================================================== -Change in Verified Enrollments Last Week Metric -====================================================== - -This metric reports the difference between the number of enrolled students who -are in the verified certificate track as of the end of the day yesterday and at -the end of the day one week ago. +This count reports the number of currently enrolled students who have elected +to pursue a verified certificate for the course. ====================================== Enrollment Over Time Report ====================================== -The daily total enrollment count, through the date of the last update, is -available for review or download. Columns show each **Date** and its **Total +The daily count of current enrollments, through the date of the last update, is +available for review or download. Columns show each **Date** and its **Current Enrollment**. The report includes additional columns for courses that offer certification @@ -120,7 +119,7 @@ students who did not elect one of those options. To download the Enrollment Over Time report in a comma-separated value file, click **Download CSV**. The CSV file contains the following columns: -* count (total enrollment) +* count (current enrollment) * course_id * created (the date and time of the computation) * date diff --git a/docs/en_us/dashboard/source/enrollment/Enrollment_Geography.rst b/docs/en_us/dashboard/source/enrollment/Enrollment_Geography.rst index 02b4c184a..b35683766 100644 --- a/docs/en_us/dashboard/source/enrollment/Enrollment_Geography.rst +++ b/docs/en_us/dashboard/source/enrollment/Enrollment_Geography.rst @@ -23,17 +23,17 @@ information about the computations, see :ref:`Reference`. Geographic Distribution Map ====================================== -The map uses a color scale to indicate the percentage of total enrollment -represented by students from each country. The darker the shade, the higher the -enrollment percentage. You can view the enrollment total for each country: move -your mouse over the map. +The map uses a color scale to indicate the percentage of current course +enrollment represented by students from each country. The darker the shade, the +higher the enrollment percentage. You can view the current enrollment count for +each country by moving your mouse over the map. In this example, the country with the highest number of enrolled students is -the United States. The cursor is pointing to Brazil, and a tip shows the +the United States. The cursor is pointing to Brazil, and a tooltip shows the percentage of students enrolled in the course from that country. .. image:: ../images/geography_chart.png - :alt: Map showing the tip for the country of Brazil. + :alt: Map showing the tooltip for the country of Brazil. ====================================== Total Countries Represented Metric @@ -69,8 +69,8 @@ Geographic Breakdown Report .. the downloadable report will have country/total/percentage The columns in this report show each **Country** and its **Percentage** and -**Total Enrollment**. Students whose location cannot be determined are reported -in the "Unknown" category. +**Current Enrollment**. Students whose location cannot be determined are +reported in the "Unknown" category. To download the Enrollment Over Time report in a comma-separated value file, click **Download CSV**. The CSV file contains the following columns: diff --git a/docs/en_us/dashboard/source/front_matter/change_log.rst b/docs/en_us/dashboard/source/front_matter/change_log.rst index e9eb9cfa2..45746b92b 100644 --- a/docs/en_us/dashboard/source/front_matter/change_log.rst +++ b/docs/en_us/dashboard/source/front_matter/change_log.rst @@ -12,6 +12,10 @@ Change Log * - Date - Change + * - 6 Aug 2015 + - Added the Total Enrollment metric to the :ref:`Enrollment_Activity` + topic. Updated descriptions of enrollment computations throughout the + guide to distinguish total enrollment from current enrollment. * - 23 Jun 2015 - Updated the :ref:`Performance_Graded` and :ref:`Performance_Ungraded` sections. Submission data is now averaged rather than summed.