Documentation Audiences#
Open edX documentation is organized by the following audiences:
Educators, who build and/or run online courses using Studio.
Site Operators, who install, deploy, and configure Open edX sites.
Developers, who contribute new features or bug fixes to the core Open edX platform, or develop other components and XBlocks that integrate with the core platform.
When you develop new documentation, you should identify the audience(s) who need the information. Some platform changes may need you to address multiple audiences. For example, a new feature may require instructions for Site Operators to enable it, and for Educators to use it in a course.
See also
About Open edX® Documentation Standards (concept)
Documentor Guidelines (reference)
Documentation Maintenance Process (reference)
Guidelines for Writing Global English (reference)
Open edX Documentation Writing Style Guide (reference)
Documentation Templates (reference)
Quick Reference: Writing RST (reference)
Update An Existing Doc via GitHub (how-to)
Add New Documentation via GitHub (how-to)
Report a problem with the docs (how-to)
Maintenance chart
Review Date |
Working Group Reviewer |
Release |
Test situation |