Documentation Working Group
- Marco Morales
- Sarina Canelake
- John Swope
Charter
The Documentation Working Group focuses on:
Comprehensive Documentation: Assist in developing detailed guides and references for all user roles (educators, course operators, site operators, and developers).
Improved Discoverability: Implement strategies to make documentation accessible, easy to find, and navigate (with a clear structure, table of contents, indexing, and search functionalities).
Enhanced Reliability: Ensure that documentation is always up-to-date and easily accessible.
A Sensible Ecosystem: Prioritize and support an Open edX® documentation ecosystem that has clear sources of truth that are best suited for their purpose or need.
Community Engagement: Encourage a collaborative environment where community members can contribute and find support.
By concentrating on these areas, we aim to provide a robust and user-friendly documentation ecosystem on Read the Docs that supports the Open edX stakeholders.
How to join us
All public Working Group meetings follow the Recording Policy for Open edX Meetings
Join our Slack Channel, #wg-documentation
Join our monthly meetings - available on the WG Meetings Calendar (see Active Working Groups for instructions, at the top)
How we make decisions
By default, decisions are made by lazy consensus:
Lazy consensus means that when you are convinced that you know what the community would like to see happen, you can assume that you have consensus in favor of the proposed work and and get on with it. You don’t have to insist people discuss and/or approve your plan, and you certainly don’t need to call a vote to get approval. You just assume you have the community’s support unless someone says otherwise.
Lazy consensus works only if you communicate with enough advance notice, and with enough details that people who would object have the time and the necessary information to do so. Generally speaking, it’s better to over-communicate.
How to work on issues
We can organize an internal sprint to focus on 2 or 3 key documentation issues to ensure that important and urgent updates are promptly addressed and have other issues to allow contributors to select and work on topics relevant to their expertise.
We can prioritize by accuracy, clarity, relevance, and discoverability.
Members
Leadership
Co-Chair - You
Co-Chair - @Sarina Canelake
Contributors
@Marco Morales
@John Swope