Page MenuHomePhabricator

Integrate new hooks system into the MediaWiki docs
Closed, DeclinedPublic

Description

Statement of Interest

Personal Information

  • Name: Devang Jagdale
  • Location: New York
  • Email: devangj9689@gmail.com
  • LinkedIn: linkedin.com/in/devangjagdale
  • GitHub: github.com/DevangJagdale
  • Phone: +1(607)-296-8196
  • Resume
  • LinkedIn
  • GitHub

Professional information

Greetings! I'm Devang Jagdale, a Computer Science graduate student at Binghamton University, with a fervent dedication to technical writing. Equipped with a robust proficiency in programming languages like Java, C++, and Python, PHP along with hands-on experience in technologies such as Docker, Kubernetes, and Jenkins, I am poised to leverage my skills in the realm of technical documentation.

My professional journey has been enriched by diverse experiences, including my role as a Subject Matter Expert at Chegg Inc. in Pune, India. Here, I delved into in-depth problems, analyzed information, and developed solutions while ensuring quality control and performance analysis. As a Subject Matter Expert in Computer Science, I effectively communicated complex concepts to others, guiding them with clarity and persuasion.

Additionally, my tenure as a Content Writer Intern at GeeksForGeeks further sharpened my technical writing abilities. I addressed technical challenges across diverse technologies, including data handling, management, and gathering in Python, through comprehensive documentation. With over 735,000 views and 115+ likes on articles, my work showcased adept communication skills and meticulous attention to detail. Within a three-month period, I published 25 technical articles, reflecting my perseverance in delivering clear, accessible explanations of complex concepts.

I am thrilled about the prospect of applying my technical prowess and passion for documentation to make impactful contributions to the Wikimedia community as a technical writer.

Work examples

Research Papers

Articles

Project title
Integrate New Hooks System into the MediaWiki Documentation

Synopsis:
MediaWiki 1.35 introduced a new system of handling hooks in 2020, which is integral for extension development and maintenance. However, the existing documentation on MediaWiki.org lacks comprehensive coverage of this new hook system, hindering developers' understanding and utilization of these hooks. This project aims to improve the documentation of the new hook system, making it more accessible and comprehensive for developers within the Wikimedia technical community.

Some Areas for Improvement Identified:

  1. Some internal and external page links on the Hooks documentation page are not functioning properly.
  2. Introduction to the functionality of each individual hook is lacking on their respective pages.
  3. It is necessary to include links to the descriptions of relevant variables in the details section of each individual hook page.
  4. The absence of comprehensive end-to-end examples for hook implementation poses challenges for new users in understanding the workflow and functionality within a single page.

Solution/Approach:
To address the deficiencies in the existing hook documentation, I propose the following approach:

  1. Conduct a comprehensive audit of the current hook documentation on MediaWiki.org to identify gaps and inconsistencies in coverage.
  2. Enhance the existing documentation by adding detailed information about the new hook system, including usage examples and best practices.
  3. Streamline the documentation structure to improve usability and accessibility for developers, ensuring easy navigation and understanding.
  4. Collaborate with the Wikimedia technical community to gather feedback and incorporate suggestions for continuous improvement.

Proposed Timeline:
Below plan is proposed considering a 2 week sprint and at end of each a mentor review is done.

PeriodTask
Phase 1: May - June
May 10 - May 24- Information Gathering and Audit
- Obtain clarifications on hooks from the developer team if needed
- Review existing hook documentation on MediaWiki.org and identify gaps
- Gather feedback from the Wikimedia technical community on hooks
May 25 - June 5- Identify areas requiring hands-on experience before documentation
- Develop a comprehensive strategy for creating and restructuring pages from various sources
- Review and integrate feedback from mentors into the plan (Mandatory review by google between June 5 - June 12)
Phase 2: June - September
June 8 - June 21- Familiarize with the project and codebase
- Work on formatting documentation according to MediaWiki.org standards
- Begin writing and editing documentation for the Manual:hooks system on MediaWiki.org
June 22 - July 5- Incorporate feedback from the Wikimedia technical community into the documentation
- Conduct initial reviews of the enhanced documentation
- (Mandatory review by google between July 5 - July 29)
July 6 - July 19- Address any remaining gaps or inconsistencies identified during feedback
- Finalize and polish the enhanced documentation
July 20 - August 2- Write and edit documentation for individual hook pages on MediaWiki.org
- Update progress reports and communicate with project mentors and stakeholders
August 3 - August 16- Continue writing and editing documentation, focusing on clarity and completeness
- Ensure compliance with licensing restrictions and accuracy of information
- Monitor feedback and engagement with the documentation
August 17 - August 30- Begin working on the git:mediawiki/core repository to identify documentation needs
- Collaborate with the Wikimedia technical community to address issues or concerns
September 1 - September 14
- Gather feedback on usability and effectiveness of documentation
- Plan necessary updates or revisions based on feedback received (Mandatory review by google between September 5 - September 12)
September 15 - September 28
- Conduct additional reviews and revisions to address feedback
- Review enhanced documentation for clarity and effectiveness
Phase 3: October - November
October 1 - October 29- Implement final updates and revisions to documentation based on feedback received
- Finalize all documentation updates and revisions
- Complete final project evaluation and submit necessary documentation and reports
- Reflect on project outcomes and lessons learned for future reference
- (Mandatory review by google between October 22 - October 29)

Expectations for Participation and Feedback:
I am enthusiastic about contributing to this project and am committed to maintaining regular communication with mentors and stakeholders throughout the project duration. I will promptly address feedback and ensure that the documentation meets the needs of the Wikimedia technical community.

Budget
Given the outlined timeline, deliverables, and scope of the project, I propose a budget of $10,500. This budget aligns with the project's requirements and allows for the successful completion of all proposed tasks. Budget is negotiable.

PhaseBudget
Phase 1$2500
Phase 2$6000
Phase 3$2000

Event Timeline

apaskulin subscribed.

Hi @Devangj9689, Thanks for your interest in Google Season of Docs. I really like the areas for improvement you identified and the way you outlined your approach, especially getting feedback from the community. One piece of feedback: Can you add a link back to the project description on the wiki page?

Thank you! I'm going to move your proposal into the Reviewed column. We'll let you know on May 10 if we've selected your proposal.

Thanks for your insightful comments @apaskulin. I have added the link to project description. Please let me know if any further information or changes are needed.

Hi @Devangj9689, Unfortunately, we've chosen not to move forward with the project to integrate the new hooks system into the MediaWiki docs. We really liked your statement of interest, but we had significantly more applications for the other project. Feel free to submit another statement of interest for the selected project.