Skip to content

Commit

Permalink
Remove the Course Operators persona (#562)
Browse files Browse the repository at this point in the history
* Remove the Course Operators persona

* Add ADR about removing Course Operators persona

* Provide a bit more clarity on personas
  • Loading branch information
sarina authored Sep 12, 2024
1 parent 14e0878 commit aff8d05
Show file tree
Hide file tree
Showing 11 changed files with 43 additions and 59 deletions.
1 change: 0 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ This repository contains source files for the `Open edX Documentation`_ site. Th
The `Open edX Documentation`_ site contains complete documentation for:

* Educators
* Course Operators
* Site Operators
* Developers

Expand Down
2 changes: 0 additions & 2 deletions source/course_ops/concepts/index.rst

This file was deleted.

2 changes: 0 additions & 2 deletions source/course_ops/how-tos/index.rst

This file was deleted.

2 changes: 0 additions & 2 deletions source/course_ops/index.rst

This file was deleted.

19 changes: 0 additions & 19 deletions source/course_ops/quickstarts/index.rst

This file was deleted.

2 changes: 0 additions & 2 deletions source/course_ops/references/index.rst

This file was deleted.

6 changes: 2 additions & 4 deletions source/documentors/concepts/doc_audiences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@ Documentation Audiences

Open edX documentation is organized by the following audiences:

* **Educators**, who build online courses using Studio.
* **Educators**, who build and/or run online courses using Studio.

* **Course Operators**, who run online courses, using features in the LMS.

* **Site Operators**, who install and configure Open edX.
* **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.

Expand Down
37 changes: 37 additions & 0 deletions source/documentors/decisions/0006-remove-course-operators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Remove Course Operators persona
###############################

Status
******

**Accepted**

Context
*******

As documented in :doc:`0001-purpose-of-this-repo`, we list out a number of
target personas for whom to create documentation; one of these is the "course
operator" persona, defined as those who run an Open edX course.

In practice, we have not developed documentation for this persona. We have found
that there is a very blurry line between someone who authors a course (an
"Educator") and someone who runs one. As such, documentation about how to
utilize a given feature frequently combines the needs of an educator and a
course operator into one document.

Decision
********

We will no longer have the persona of "Course Operator". This was discussed in
multiple Documentation Working Group meetings in August and September of 2024.

All documentation related to building/authoring a course, running a course, and
utilizing all "course personell"-type software (including but not limited to
Studio, the LMS Instructor Dashboard, the Staff Debug interface, and Aspects)
will lie under the "Educator" persona.

Consequences
************

* All pages for Course Operators will be deleted. There was never any authored
content on these pages; they were just stubs.
1 change: 1 addition & 0 deletions source/documentors/decisions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Documentation Decisions
3. Documentation Layout <0003-documentation-layout>
4. Don't Use AutoSectionLabel Extension <0004-no-auto-section-label>
5. Use Markdown READMEs for repos published to npm <0005-markdown-for-npm-readmes>
6. Remove Course Operators persona <0006-remove-course-operators>
1 change: 0 additions & 1 deletion source/documentors/references/doc_checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Your Audience
Make sure your documentation is targeted to the right audience and organized under that audience's section of the documentation. Each topic in the documentation is for one of the following audiences:

* Educators
* Course Operators
* Site Operators
* Developers

Expand Down
29 changes: 3 additions & 26 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Open edX Documentation

Community <community/index>
Educators <educators/index>
Course Operators <course_ops/index>
Site Operators <site_ops/index>
Developers <developers/index>
Documentors <documentors/index>
Expand All @@ -30,7 +29,6 @@ Open edX Documentation
:caption: Quick Starts

Educators: Build a Course <educators/quickstarts/build_a_course>
Course Operators: Run a Course <course_ops/quickstarts/index>
Site Operators: Set up Open edX <site_ops/quickstarts/index>
Developers: Contribute to Open edX <developers/quickstarts/index>
Documentors: First Documentation PR <documentors/quickstarts/first_documentation_pr>
Expand All @@ -54,7 +52,7 @@ Open edX Documentation

.. toctree::
:maxdepth: 1
:caption: Educators: Build an Open edX Course
:caption: Educators: Build and/or Run an Open edX Course

Quickstarts <educators/quickstarts/index>
How-tos <educators/how-tos/index>
Expand All @@ -69,27 +67,6 @@ Open edX Documentation

Educators' Home

.. grid-item-card::
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

.. toctree::
:maxdepth: 1
:caption: Course Operators: Run Open edX

Quickstarts <course_ops/quickstarts/index>
How-tos <course_ops/how-tos/index>
Concepts <course_ops/concepts/index>
References <course_ops/references/index>

+++
.. button-ref:: course_ops/index
:color: primary
:outline:
:expand:

Course Operators' Home

.. grid-item-card::
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0
Expand Down Expand Up @@ -138,7 +115,7 @@ Open edX Documentation

.. toctree::
:maxdepth: 1
:caption: Documentors
:caption: Documentors: Document the Open edX Platform

Quickstarts <documentors/quickstarts/index>
How-tos <documentors/how-tos/index>
Expand All @@ -159,7 +136,7 @@ Open edX Documentation

.. toctree::
:maxdepth: 1
:caption: Translators
:caption: Translators: Translate the Open edX Platform

Quickstarts <translators/quickstarts/index>
How-tos <translators/how-tos/index>
Expand Down

0 comments on commit aff8d05

Please sign in to comment.