Table of Contents

...

If partner, learner, or business documentation needs updates, anyone in the organization—including program coordinators, partner managers, and course author support—can submit a JIRA ticket to the DOC project. The documentation team will prioritize these requests.

Other teams will use the information that the documentation team has provided to maintain their documentation products.

...

In general, you can use the following checklist to determine whether a feature or change needs documentation. The page for each product has more information for that specific product.

...

• Is documentation for this feature a contractual obligation?

...

• Will this feature/change require action from the guide's audience? For example, will this change affect any settings that system administrators or developers depend on, or will this change affect the way system administrators operate an Open edX instance?

...

• Will this feature/change be visible to the guide's audience, even if the feature/change doesn't require action? For example, time zone improvements caused course due dates and times to change automatically to a learner's new time zone. Previously, both the Building and Running guide and the EdX Learner's Guide specifically mentioned that all times were in UTC.

...

• Will this feature/change provide a new opportunity for the guide's audience? For example, is the feature a new tool that course teams can (but aren't required to) use?

...

• Will this feature/change cause new events or SQL tables to appear in data packages?

Update Documentation or Submit a Documentation Request

...

For more information, see Creating and Updating Documentation - RTD.

Request Help from the Doc Team

...