2024-08-07 Documentation WG Meeting notes

10am ET -

Introductions / Goals

• @Colin Fredericks - edX documentation have been a huge help / asset historically, and ensuring others benefit from them as well would be great

• @John Swope - have struggled with docs, want to make better. This group can unify docs and have alignment w/ core product. Group can be in alignment w/ BTR, docs follow releases. Rubrics & standards; help troubleshooting

• @Sarina Canelake - want to enable the community to enable and maintain great documentation easily. ease of access to docs (authors / readers) is important.

• @Michelle Philbrick - docs aren’t great to find, I want to use the platform but don’t know where to start

• Learner Docs - the challenges here often connect with mapping current platform version to the right version of documentation. a learner on edx.org would see something different than a learner on an instance running an older release (for example)

• Video Content - high cost to maintain, high value / impact but need to be strategic in its use.

• Documentation Forks - had previously been considered by community members (for instance specific docs) but this didn’t seem like an obvious / easy thing to do

  • Release based documentation switcher? Step in the right direction

  • Make sure Google is indexing the right version

• Redwood documentation - Gratitude for the redwood docs, a step up in documentation clarity and a good sign that we are moving in the right direction

• BTR release testing: in the future, synergy: BTR test cases have documentation, and the docs can be updated with latest screenshots, changed steps, etc

Charter Review

• Review draft charter from @Maria Fernanda Magallanes Z