OpenJS Foundation / Google Season of Docs 2024

The OpenJS Foundation is applying for the 2024 Google Season of Docs.

OpenJS hosts 35 critical JavaScript projects including Node.js, Electron, jQuery, webpack, Appium and Jest. Our mission is to support the healthy growth of JavaScript and web technologies by providing a neutral organization to host and sustain projects, as well as collaboratively fund activities that benefit the ecosystem as a whole.

We are looking for a few skilled technical writers who can help with a number of our projects. We have a large, welcoming community and would like to help grow new participants.

If you have any questions, please reach out on the OpenJS Foundation Slack.

Here is a list of our proposals, as well as some resources to help you learn about the OpenJS Foundation.

Submitting Documentation Proposals (for prospective mentors)

If you would like to submit a proposal for an initiative that you would like to mentor, feel free to open a PR to add another section to this document above. Examples can be found at https://developers.google.com/season-of-docs/docs/project-ideas & https://developers.google.com/season-of-docs/docs/project-metrics

### Project Idea: {project name}

#### Problem

#### How would we measure success?

#### What skills would a technical writer need to work on this project?

#### Expected outcomes:

* **Must Have**
* **Nice To Have**

#### Volunteers / Mentors

#### Contact info

Projects

Project Idea: Node.js Learn -- Creating World-class Learning material for Node.js

Problem

The Node.js runtime is the world's most popular and widely adopted JavaScript runtime. Node.js enables JavaScript Developers to create the next big thing. Node.js is a fundmanetal cornterstone of the Web.

Yet, as popular as Node.js might be, Node.js as a project needs fundamental learning material that allows people to kickstart and dive deep into the powerhouse of Node.js. Hundreds of content creators support the Node.js community with courses and learning material. Still, the Node.js project itself lacks fundamental learning material that allows newcomers and existing users of Node.js to get quickly started with the basics to the next big thing that Node.js provides.

This project aims to update the existing Learn material available on the Node.js website and create new learning material Some of the expected tasks of this project include:

Reorganising and re-categorising the existing content
Rephrasing and improving existing content
Updating existing Learn outdated material
Introducing new learning material that is relevant to the user base of Node.js

During this mentorship, the mentee can expect to be guided through the basics and fundamentals of Node.js to the gritty nitty and the shiny new features of Node.js.

How would we measure success?

The success of this project is measured on at least 3 pillars for Node.js's Learn material.

That we successfully audited the existing learning material/content
- Not all learn pages might require extensive updates, so the success criteria are personal and depend on outcomes throughout the rundown of this mentorship.
That new learning material was created based on the project's needs. It is up to the mentee to come up with new ideas and it is expected that the mentor will provide feedback and guidance regarding what needs to be done.
That both the mentor and the mentee are happy with the resulting outcome of this mentorship.

Since these requirements are dynamic, the project's actual success indicator is determined by both parties agreement (mentor and mentee) that all the required work was accomplished.

For the mentorship itself and the resulting outcomes, we can expect that the success of the project is measured by:

Improved documentation completeness, covering essential aspects of Node.js.
Enhanced clarity, ensuring that developers can easily understand the concepts and usage of Node.js.
Positive feedback and reduced queries related to Node.js usage on community forums and GitHub issues.

What skills would a technical writer need to work on this project?

Expected outcomes:

Must Have
- Updated Learning material covering Node.js features, including detailed explanations and usage examples.
- Improved organization and navigation within the Learning material to enhance usability.
Nice To Have
- Better SEO and structure for the Learn material
- Interactive examples or demos showcasing Node.js capabilities

Volunteers / Mentors

Lead Mentor: Claudio Wunder
Co-mentors might include Node.js Core collaborators and other maintainers/collaborators of the Node.js website.

Contact info

Inquiries should, in general, be made through OpenJS's Slack on the #nodejs-website channel or through direct contact with the mentors through OpenJS's Slack or an e-mail to cwunder@gnome.org

Resources