- Name: Chidera Winifred John
- Location: Uyo, Nigeria
- Email: winifredjohchidera123@gmail.com
- LinkedIn: Winifred John
- Github: johnwinifred
I am a Technical writer with expertise in user research, developer-based documentation, and documentation management, dedicated to delivering high-quality documentation and fostering community engagement across open-source projects.
With over 2 years in Front-end Web development, I have strong proficiency in Javascript, and Typescript with basic knowledge of server-side languages like NodeJs and Python. I have contributed to open-source projects like Hacktoberfest 2022 and improved their developer documentation.
My expertise is in user-analysis research and data gathering. I excel in gathering feedback from the community and leveraging it to create comprehensive user-persona case studies allowing me to tailor documentation to enhance the user experience effectively. My proficiency in this area makes me an ideal candidate for improving the developer documentation on OpenJS.
Furthermore, I am already well-versed in developer documentation, Docs-as-Code, and API documentation. My expertise includes creating tutorials, how-to guides, API docs, and whitepapers. With my software development background, I have a strong foundation in Javascript, Typescript and running tests.
I am also Cisco Certified in Networking Fundamentals, therefore, I have a clear understanding of technical concepts related to HTTP/1.1 clients, connection pooling, KeepAlive, and related networking topics.
Node.js Undici is a high-performance HTTP/1.1 client with connection pooling, KeepAlive, and more, providing a low-level HTTP client API. However, its documentation lacks completeness, clarity, and examples, which makes it challenging for developers to understand and utilize the full potential of Undici effectively.
Working on Undici requires careful planning and collaboration. I have gone through the scope of the project and was able to point out 4 areas that I would work closely with the Project mentors to achieve.
- Documentation Structure: Provide a structure that makes the documentation easy to navigate, findable and have proper backlink usage.
- Documentation Design: This involves typography, formatting the texts, Visual aids (video tutorials, images, code snippets). There has to be consistency across all Undici documentation.
- Documentation Content: Detailed and explained but also concise. This means we have to provide both in-depth tutorials and how-to-guides for quick search.
- Documentation management: Provide guidance on maintaining and updating the published content to ensure long-term relevance and usability.
- Conduct an audit of the existing documentation and identify gaps through feedback from the community forum
- Work closely with the project mentors to work on a standard structure of the documentation to increase the quality and ensure easy maintenance.
- Work with the engineering support team and developers to simplify technical concepts
- Create visual guides and appropriately include relevant images and code snippets in the documentation
- Work with the engineering support team and project mentors to develop comprehensive API documentation for Undici.
- Adopt proper backlink usage to enhance SEO and discovery among the users
- Manage documentation migration to Docusarus or Gitbook.
- Review the documentation with the Project mentors to ensure that the overall documentation is findable, clear, concise and complete.
- Research & Auditing: $2000
- Writing & Editing: $8000
- Subscription for tools and software: $150
- Total: $10,150
I am open to discussing the budget.
| Phase | Timeline | Tasks |
|---|---|---|
| Phase 1 | May - June | - Onboarding and consulting project mentors and engineering support team. |
| - Analyse main project GitHub issues, and community channels data to identify areas for improving the documentation. | ||
| - Review existing Undici documentation to identify outdated information and areas for improvement. | ||
| - Develop a detailed plan outlining strategies for updating and enhancing the documentation, prioritizing key HowTo guides. | ||
| Phase 2 | July - September | - Writing and Documentation Design |
| - Update and improve documentation completeness, covering all aspects of Undici's functionality. | ||
| - Develop new HowTo guides as needed for areas lacking documentation, ensuring clarity, completeness, and relevance to developers. | ||
| - Regularly update progress reports to track the completion status of each documentation task and ensure alignment with project goals. | ||
| Phase 3 | October | - Editing and Initial Review |
| - Ensure consistency and adherence to documentation style guides throughout all documentation updates. | ||
| - Start working on API documentation with the developers. | ||
| - Conduct thorough reviews to address any identified issues or gaps in the documentation. | ||
| Phase 4 | November - December | - Final Review and Publication |
| - Finalize the updated documentation for Undici and publish it for public access, ensuring ease of navigation and search functionality. | ||
| - Test navigation paths, search functionality, and page layouts to ensure a user-friendly experience. | ||
| - Finalize the API documentation for Undici and review with the developers and project mentors. | ||
| - Provide guidance on maintaining and updating the published content to ensure long-term relevance and usability. |
I am eager to bring my skills and experience to OpenJS, and to also collaborate with the team and community to achieve our shared goals. I believe in effective communication and I look forward to the support from project mentors and the engineering team during the onboarding process. On my part, I would ensure to adequately complete tasks as assigned in due time and relate to the team in case of any issues or progress.
I understand that every project comes with its unique set of challenges and complexities. I am prepared to adapt to evolving requirements, adjust timelines as needed, and ensure we stay on track towards achieving our goals.
Beyond the immediate goals of the project, I am eager to support the ongoing development and maintenance of the documentation, contribute to future initiatives, and continue to be an active and engaged member of the OpenJS community
I am open to working on the project ‘Creating World-class Learning Material for NodeJs’ With my expertise in creating tutorials (written and video content), I am eager to work with project mentors and experienced NodeJS developers to break down concepts and develop learning structure that is tailored toward the growth of the community.