@@ -38,6 +38,75 @@ If you would like to submit a proposal for an initiative that you would like to
38
38
39
39
---
40
40
41
+ ## Projects
42
+
43
+ ### Project Idea: Node.js Learn -- Creating World-class Learning material for Node.js
44
+
45
+ #### Problem
46
+
47
+ The Node.js runtime is the world's most popular and widely adopted JavaScript runtime.
48
+ Node.js enables JavaScript Developers to create the next big thing. Node.js is a fundmanetal cornterstone of the Web.
49
+
50
+ 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
51
+ into the powerhouse of Node.js. Hundreds of content creators support the Node.js community with courses and learning material.
52
+ Still, the Node.js project itself lacks fundamental learning material that allows newcomers and existing users of
53
+ Node.js to get quickly started with the basics to the next big thing that Node.js provides.
54
+
55
+ This project aims to update the existing Learn material available on the Node.js website and create new learning material
56
+ Some of the expected tasks of this project include:
57
+
58
+ - Reorganising and re-categorising the existing content
59
+ - Rephrasing and improving existing content
60
+ - Updating existing Learn outdated material
61
+ - Introducing new learning material that is relevant to the user base of Node.js
62
+
63
+ During this mentorship, the mentee can expect to be guided through the basics and fundamentals of Node.js to the gritty nitty
64
+ and the shiny new features of Node.js.
65
+
66
+ #### How would we measure success?
67
+
68
+ The success of this project is measured on at least 3 pillars for Node.js's Learn material.
69
+
70
+ - That we successfully audited the existing learning material/content
71
+ - Not all learn pages might require extensive updates, so the success criteria are personal and depend on outcomes
72
+ throughout the rundown of this mentorship.
73
+ - That new learning material was created based on the project's needs. It is up to the mentee to come up with new ideas
74
+ and it is expected that the mentor will provide feedback and guidance regarding what needs to be done.
75
+ - That both the mentor and the mentee are happy with the resulting outcome of this mentorship.
76
+
77
+ Since these requirements are dynamic, the project's actual success indicator is determined by both parties
78
+ agreement (mentor and mentee) that all the required work was accomplished.
79
+
80
+ For the mentorship itself and the resulting outcomes, we can expect that the success of the project is measured by:
81
+
82
+ - Improved documentation completeness, covering essential aspects of Node.js.
83
+ - Enhanced clarity, ensuring that developers can easily understand the concepts and usage of Node.js.
84
+ - Positive feedback and reduced queries related to Node.js usage on community forums and GitHub issues.
85
+
86
+ #### What skills would a technical writer need to work on this project?
87
+
88
+ #### Expected outcomes:
89
+
90
+ * ** Must Have**
91
+ - Updated Learning material covering Node.js features, including detailed explanations and usage examples.
92
+ - Improved organization and navigation within the Learning material to enhance usability.
93
+
94
+ * ** Nice To Have**
95
+ - Better SEO and structure for the Learn material
96
+ - Interactive examples or demos showcasing Node.js capabilities
97
+
98
+ #### Volunteers / Mentors
99
+
100
+ - Lead Mentor: [ Claudio Wunder] ( https://github.com/ovflowd )
101
+ - Co-mentors might include Node.js Core collaborators and other maintainers/collaborators of the Node.js website.
102
+
103
+ #### Contact info
104
+
105
+ Inquiries should, in general, be made through [ OpenJS's Slack] ( https://openjsf.org/collaboration ) on the #nodejs-website channel
106
+ or through direct contact with the mentors through OpenJS's Slack or an e-mail to
` [email protected] `
107
+
108
+ ---
109
+
41
110
## Resources
42
111
43
112
### OpenJS Foundation
0 commit comments