Call for help with Documentation!

First, a huge thanks to everyone who has submitted feedback, comments and ideas on tCRIL’s Documentation Restructuring Proposal. Your input has been highly valuable in helping us formulate next steps to advance the project to improve Open edX documentation.

Where we are today

We’ve created a central index/tree for all Open edX documentation here: Open edX Documentation — Latest Documentation documentation

We’ve decided to organize the documentation tree around key Open edX personas/users, namely:

  • Educators/course authors
  • Course operators
  • Site Operators
  • Developers

We’ve identified four key types of documentation that each persona should have:

  • Quick start
  • How-tos
  • Concepts
  • References

Here’s an example of what those four doc types look like for the Educator/Course Author persona: Open edX Educators — Latest Documentation documentation

What we’d like to do next

Before we create content itself (or repurpose it from current readthedocs), we’d like to create a comprehensive “table of contents” or “glossary” for each persona. In other words, let’s create a robust list of docs that each persona needs, in each document type. For example:

What are the how-tos a course author would need?
What are the reference docs an instructional designer would need?
What are the how-tos an extension developer would need?

Here is an example table of contents for Educator/Course Author how-tos (not complete): Educators: How-tos — Latest Documentation documentation

We’d like to invite the community to help us crowd-source these Tables of Contents. We’ll use this as the starting point for what content needs to be written and where we should focus future energy. Relatedly, are you interested in “owning” a persona, or a content type for a persona? Helping us build out the documentation for that persona and keeping it up to date? Don’t worry if you don’t have a lot of experience, we can help. Please reach out and we’ll set you up with everything you need to help us build out Docs 2.0.

Respond below, or reach out to Jenna (jmakowski@tcril.org) or Feanil (fpatel@tcril.org) to learn more.

1 Like

Hi @jmakowski , Shannon and I are in! I’ll connect with you via email and just let me know if there are any working sessions or meetings that you’d like us to participate in. Here we go!

1 Like

@jmakowski
I am interested in creating documentation. I can commit 5 Hours per day on this documentation.

1 Like

@feanil @jmakowski
Greetings! I am interested in participating. I am new to this forum, yet have done a deep dive at eduNEXT to explore Knowledge and documentation initiatives.

I’m Wanda and serve as the Knowledge Management Specialist at eduNEXT in Colombia. I’m an experienced educator and learner at heart.

To date, we have created a Knowledge Management Strategy and Action Plan at eduNEXT which incorporates best practices framework around knowledge gathering and sharing, and includes documentation best practices. In late June, we began our pilot program in the area of Service Delivery, which is made up of 6 iterative cycles (2-week sprints each) to assess and improve our internal and public documentation to enhance the customer experience. Thanks to your efforts, we were able to accelerate our activity by incorporating several elements from your new Open edX Documentation proposal, such as user personas, panels for quick navigation, tools etc. Thus, we adapted our User Roles to align with our documentation and with our eduNEXT Control Center (ECC) management console. We are excited to see the final outcomes. That said, we are at the same point in our endeavors. Identify core content for each role. So I was happy to see your invitation to contributor as it aligns perfectly to what we are doing and where we are in the planning and implementation of our project.

In July, I met Feanil and along with a few members of our team at eduNEXT, we discussed how we can collaborate to work through some of the documentation created and provide feedback. So, I’m looking forward to getting more involved in that as well.

Feel free to reach out and let me know how I can best be of assistance. Thanks.

Also, if you’d like more information about our pilot program for Knowledge and documentation, I’d be happy to connect with you.

2 Likes

Hello @jmakowski,

I am Utku and am the lead developer for our instance at NYU Shanghai.

I have been working on our instance for the past year and have also been active in the forums (including the depreciated Tutor forum) by answering questions to the best of my ability.

My experience mostly covers the Site Operators and Developers personas and I would like to contribute to the documentation in these areas.

1 Like

Hi @jmakowski I’m really excited about the work that’s happening around Open edX documentation. Should we be sharing topic suggestions in this thread, or through a different channel?

I’d also be interested in helping to build out documentation, if appropriate opportunities are available.

1 Like

Thanks Parvin, great to hear! I’ll email you with more details.

1 Like

Fantastic Wanda, we’ll be emailing shortly with more details.

Great Utku, expect an email shortly!

Thanks Michael! Will be in touch via email shortly.