-
Notifications
You must be signed in to change notification settings - Fork 58
Season of Docs 2024 Organization Application: OpenSauced
🍕 OpenSauced is applying to GSOD 2024! Below is our application
PROPOSAL TITLE: Enhancing Open Source Developer Experience through Comprehensive Guides and API Documentation for OpenSauced
At OpenSauced, we're dedicated to enhancing the open-source experience for everyone, providing support and resources for contributors, maintainers, and teams through our tools and the insights we provide. Through our product, content, and documentation, we emphasize the value of:
- Collaboration, transparency, and open communication in open source
- Understanding the value and impact of open-source contributions
- Becoming a positive open-source citizen through meaningful engagement
- Diverse contributions, including community support, issue reporting, blogging, and pull requests.
- Recognizing key contributors and highlighting individual journeys and achievements
- Growing a healthy and successful contributor ecosystem in open-source
We recognize the important role of documentation in empowering contributors. Because of this, we want to expand our existing resources with detailed guides and API documentation, ensuring the open-source community can fully leverage the power of OpenSauced and become positive open-source citizens.
Problem Statement:
As OpenSauced's tools and APIs grow in capability, the need for comprehensive documentation is increasingly apparent. Currently, our API documentation is limited to technical descriptions within Swagger. The lack of in-depth guides and tutorials impedes developers' ability to fully utilize OpenSauced's API and product, impacting both user engagement and their ability to contribute. Addressing this gap will create a better open-source developer journey, empower contributors in both the OpenSauced ecosystem and open source ecosystem, and unlock the full potential of our tools.
Because we focus on creating a full contributor journey with our documentation, providing opportunities for brand-new contributors to experienced contributors, maintainers, and teams, it’s important for us to create materials that support the full developer journey and experience for contributors. The proposed project will ensure coverage across the contributor journey, provide documentation and guides that are accessible to a global audience, and create clear paths for learning, communication, and contribution.
Project Scope:
The "Enhanced Guides and API Documentation" project will focus on:
- Conducting a thorough audit of the existing API documentation, guides, and courses .
- Developing comprehensive, documentation, guides, and tutorials for the OpenSauced API and contributor journey.
- Gathering and incorporating feedback from the developer community to refine the documentation.
- Establishing a clear, accessible structure for all documentation, ensuring consistency and ease of navigation.
Out-of-Scope Work:
- The project will not cover the development of new API features or functionalities.
- Familiarity with JavaScript and open source project workflows.
- Proficiency in GitHub for version control and collaboration.
- Experience in crafting educational materials for developers
- Strong communication skills for engaging with the community and soliciting feedback.
- Project management understanding for documentation updates from inception to completion.
- Technical Writer: [To be hired]
- Mentor: A developer with experience in documentation and API usage
- Advisor: Developer Experience Lead from the OpenSauced team
Success metrics include:
- A 20% increase in API utilization post-documentation update.
- Positive feedback from the developer community on the clarity and usefulness of the new guides.
- Increased interaction with OpenSauced guides and courses.
- Increased contributions to API documentation and examples.
- May: Kickoff, technical writer orientation, and documentation audit.
- June - July: Development of guides, tutorials, and updated API documentation.
- August: Community feedback collection and documentation refinement.
- September - October: Final review, updates, and publication of updated documentation.
- November: Presentation of project findings to the community.
- Technical Writer Compensation: $10,000
- Mentor Stipend: $1,500
- Community Feedback Incentives: $500
- TOTAL: $12,000
The technical writer who will work on this project should have open source experience, API documentation familiarity, and an understanding of the contributor journey within open source ecosystems. Understanding OpenSauced and our mission will help increase the success of the "DocuSauce Journey" project.