Page Comparison

...

The recent survey highlights a clear need for a unified resource that details the processes and roles associated with onboarding and the ongoing responsibilities of Core Contributors. To address this, I propose the creation of a dynamic and comprehensive "Open edX Handbook" that will be continuously updated and refined to meet the community’s evolving needs.

Initially, the handbook will involve relocating and consolidating existing Core Contributor information and expanding the information in a newly established space (eg. Similar to The OpenCraft Handbook). Over time, this space will evolve into a centralized, all-encompassing resource designed to enhance documentation accessibility, clarify information, and reduce information overload for the entire Open edX community, not just Core Contributors.

The primary goals of the first phase of this initiative are toCore Contributor focused:

1. Support the Core Contributor onboarding process

2. Provide more in-depth guidance on Core Contributor processes and tooling

3. Help Core Contributors easily locate information relevant to their roles

4. Promote effective Core Contributor participation

5. Reduce reliance on community members for straightforward answers

6. Strengthen the Core Contributor community as a whole

...

• Centralized Documentation:

  • Audit and Consolidate: Perform a thorough audit of existing documentation and consolidate it into a well-organized central repository. This will address the current challenge of overwhelming and dispersed information.

• Enhanced Content Order and Quality:

  • Revise and Organize: Improve clarity, engagement, and informativeness of the content. Ensure accessibility for both technical and non-technical users. Implement a search, structured table of contents, cross-referenced links, and a logical content arrangement to facilitate easy navigation. Address issues of scattered information that complicate access for new Core Contributors.

• Identify Content Requirements:

  • Conduct a Qualitative Study

    • Interview 5-7 Core Contributors from diverse roles to understand their specific needs and gather insights on essential handbook content.

  • Incorporate Key Information Based on Define the New Handbook Structure

    • Using the information gathered from the survey and the existing Core Contributor information define the sections of the Handbook that can be populated over time.

    • Key Information to Include from the Survey Feedback:Glossary of Terms:

      • Define abbreviations and terms (e.g. CC, OEX, TOC, OEP, ADR).

      Purpose, Vision, and Mission:

      • Clearly articulate the Core Contributor’s purpose, vision, and mission.

      Involvement Guidelines:

      • Outline actionable steps for involvement, including role-specific links

      (e.g

      • .

      , Product Managers should refer to the Roadmap).
      Role-Specific Guidance:

      • Structure content based on roles, similar to GitLab’s role-based handbook model.

      Detailed Role Definitions:

      • Define responsibilities for various Core Contributor roles.

      Commitment Assessment:

      • Provide guidelines for assessing commitments to ensure accountability.

      Communication Tools:

      • Offer guidelines for effective use of communication tools as proposed by Ali Hugo.

      Contact Information:

      • Include contact details for role-specific guidance.

      Sprint Explanations:

      • Detail the sprint process and outline expectations for each Core Contributor, including check-ins if necessary.

      Active Working Groups:

      • List all active working groups with links to their collaborative spaces.

      Content Selection:

      • Decide which information to include directly in the handbook and which to reference through links (e.g., Product Review Process, Product Proposals).

• Increased Self-Reliance:

  • FAQs and Troubleshooting: Include sections for frequently asked questions and troubleshooting to empower contributors to find answers independently, reducing the need for community support for basic queries.

• Easy Submission of Changes:

  • GitHub Repository: Host the handbook in a GitHub repository to facilitate easy submission of changes through formal pull requests. This will allow others to review and approve changes before they are implemented in the Wiki, or similar.

...

Phase 1: Initial Planning and Definition (2 weeks)

1. Define Core Sections: CONSOLIDATING INFO GATHER

   • Identify the essential sections and topics needed in the handbook based on preliminary research and feedback from core contributors.

2. Initial Input Gathering:

   • Consult with Key Stakeholders: Validate the list of sections and gather initial insights on content requirements.

   • Prioritize Sections: Determine the order in which sections should be developed, starting with the most critical ones.

...

By implementing this proposal, I hope to significantly support the onboarding experience for new Core Contributors, streamline their integration into the community, and improve their overall effectiveness and satisfaction of current Core Contributors. This comprehensive handbook will serve as a vital resource, supporting the growth and success of our community.

• Increased Self-Reliance:

  • Include sections for frequently asked questions and troubleshooting to empower contributors to find answers independently, reducing the need for community support for basic queries.