Audience: Learners

Owner: 

Introduction

The EdX Learner's Guide provides help for learners who have questions about topics including how to navigate through a course, how to complete course materials, and how to receive certificates.

The process for creating or updating documentation in this guide is the process outlined on the Creating and Updating Documentation - RTD page.

Note There is some overlap between the EdX Learner's Guide and the FAQs that Support maintains. An open question is how best to serve the learner audience without duplicating information.

Different Platform Versions

The feature sets for edX.org and Open edX learners are slightly different. We use shared files and conditional text to produce three different versions of the EdX Learner's Guide.

• EdX Learner's Guide, for edx.org learners
• Open edX Learner's Guide, for learners in Open edX courses

Files for these guides are located in the following folders.

As of November 2016, any edx.org learner information that also pertains to the Open edX learner's guide will be included in the Open edX guide, but any information that pertains exclusively to the Open edX learner's guide will not be included unless the doc team receives a request to include it and has the time to create documentation.

Draft Versions

Some features are identified as requiring complete documentation well before release, either for a contractual obligation or to assure support of a pilot. The doc team prepares documentation in these cases to as high a standard of quality as possible. The resulting documentation is published privately, meaning that an edX employee must send the URL to those that need it, and labeled "DRAFT". This type of documentation is expensive to produce and maintain, and delivery in this way should be a very infrequent exception made only when there is high value to the edX organization.

For more information about creating draft projects, see Publish Documentation on Read the Docs.