Project Proposal to MediaWiki for Google Season of Docs 2024

Name: Blessing Ene Anyebe
Email: anyebeblessing737@yahoo.com
Location: Abuja, Nigeria
LinkedIn: https://www.linkedin.com/in/anyebe-blessing-ene-kwennb/?
GitHub: https://github.com/kwennB
Link to Resume: https://docs.google.com/document/d/1xrDyvoA5-X1BeoA0-r4NgNDBPnqMN_lGhUOiSwtxP3M/edit?usp=sharing
My Written content: https://kwennb.notion.site/My-Written-Content-50b4f0d1ed9b4bd89f261ef5d94656f9?pvs=4
Time Zone: (UTC + 01:00) West Central Africa

I got into open-source about two years after I transitioned to tech. Since then, I've been interested and invested in contributing and giving back to the community, and I have done that by participating as a mentor, contributor, and community manager in diverse open-source organizations. Examples include The Good Docs project, the Technical Writing Mentorship Program, and Empower Her Community.

It can be overwhelming because you need strong technical knowledge to contribute code to certain open-source projects. But writing code isn't the only way to give back to the community or contribute to open source. I figured this out early enough and started contributing my quota to open source via documenting, teaching, and fostering the growth of communities around open source.

With my open-source explorations, I have not been accepted to GSoD, so I'm here to give it my best as usual. Although I've written several technical articles and a few documents for some projects I've previously worked on, which aren't open source, I strongly feel participating in GSoD would not only let me improve my technical documentation/writing skills but also allow me to explore new ways of contributing to open source while learning & earning at the same time.

Professional Information

Skills:

Languages: JavaScript, HTML5/CSS3.
Frameworks and Libraries: React.js, Bootstrap
Developer Tools: Git, VS Code, GitHub
Technical Writing Tools: Markdown, GitHub gist, Google tools (including Google Cloud, Docs, Analytics), Hugo, Docsify, Swagger, Postman, Mintlify,
Core Skills: Documentation, Search Engine Optimization, Problem Solving, Operating Systems, Computer Networks

Technical Writing Samples:

My Written content
Random User Generator

Open source contribution:

Actively documenting to Chronologue in The Good Docs Project.
Check my contribution: https://gitlab.com/tgdp/chronologue/docs/-/blob/main/content/en/docs/API/r_API_reference.md

Actively contributing to the technical writing mentorship program:
https://github.com/Technical-writing-mentorship-program/Technicalwritingcourse/commit/aadbe1a4d7aa700d58594eeb4f50d7945281c959
https://github.com/Technical-writing-mentorship-program/Technicalwritingcourse/commit/6817a97acaa6a9ffc2999b69bfc5edb04bc90864
https://github.com/Technical-writing-mentorship-program/Technicalwritingcourse/commit/b624837aa0e667ee2fb9405e11e078b90fe134c5
https://github.com/Technical-writing-mentorship-program/Technicalwritingcourse/commit/b0f1e9bf317e95c4c2fb9bdcf06b02a413c2e26c

I am mentoring an open-source tech writing organization in the Technical Writing Mentorship Program 2024.

Project Information

Project Title:

Complete migration of MediaWiki documentation

Detailed description

The MediaWiki software is a popular tool used by numerous websites, companies, and organizations. It helps with collecting and organizing knowledge to make it available to people. It powers Wikipedia and Wikipedia projects.

Project goals/deliverables

• Update the contents on MediaWiki with their counterparts in Meta-Wiki.
• Create equivalent documentation to cover the content on the MetaWiki.
• Review for usability and design, implement information architecture for structure, discoverability, and maintainability.

Having stated the above deliverables, here is my detailed approach to achieving them;

Update the contents on MediaWiki with their counterparts in Meta-Wiki.

I understand that some vital documentation required on MediaWiki is still on Meta, and it is hard to maintain those docs on both platforms. Since they have been identified, I intend to update the documentation to ensure they are on par with their equivalent on Meta-Wiki.
For this deliverable, I also intend to remove duplicated documentation concerning MediaWiki from Meta-Wiki.

Content duplication causes diverse challenges. It results in maintenance overhead because this requires additional effort and resources. With content duplication, you get Inconsistencies, wasted resources, searchability issues, decreased credibility, and poor user experience. This struggle is improper for an organization like MediaWiki that caters to Wikipedians and other Wikimedia projects.

Create equivalent documentation to cover the content on the MetaWiki.

In the end, we want to consolidate documentation in MediaWiki and avoid sending users to Meta for content that should be readily available on the latest platform.
For this deliverable, I would create new documentation pages on Media-Wiki as equivalents to those listed here on Meta-Wiki.
Due to the stated license issues, this deliverable involves rewriting the documentation.

Review for usability and design, implement information architecture for structure, discoverability, and maintainability.

Information architecture plays a significant role in documentation as huge as MediaWiki. It is vital and required for efficient user experience. A successful information architecture with a structured design, usability, and accessibility will help retain users, reduce bounce rates, and boost a website's popularity.

With my strong knowledge of SEO and IA, I would deliver this by researching and implementing the designs needed for each content listed here.

Project Timeline

During the 12 weeks working on the MediaWiki documentation, I intend to accomplish my deliverables following the timeline below:

Phase 1 (April 17th - 17th May): Update the contents on MediaWiki with their counterparts in Meta-Wiki

1. Information gathering - 8 days (Week 1, 2 -):
   • I will be learning more about MediaWiki and simultaneously keeping notes for every step so that new contributors can get an overview of the process from the documentation.
   • Analyze the projects in detail with my mentors.
   • I will gather information about features and usability under the guidance of mentors.
   • Setup
2. Doc writing Period - 14 days (Week 2, 3):
   • I will start documenting/updating the content to MediaWiki.
   • This period includes removing duplicated documentation concerning MediaWiki from Meta-Wiki.
3. Review - 5 days (Week 3):
   • I will work on the requested changes.
   • I will commit the new changes and get it finally reviewed.
4. First Month Evaluation - 3 days (Week 4):
   • First Month Evaluation Period.

Phase 2 (18th May - 16th June): Create equivalent documentation to cover the content on the MetaWiki

1. Information gathering - 8 days (Week 1, 2):
   • Research more about the MediaWiki sections to create and simultaneously keep notes for every step so that new contributors can get an overview of the process from the documentation.
   • Setup
   • Start creating the equivalent documentation.
2. Doc writing Period - 14 days (Week 2, 3):
   • Continue documenting the content to MediaWiki.
   • This period includes re-writing the documentation listed here to update the versions for MediaWiki.
3. Review - 5 days (Week 3):
   • I will work on the requested changes.
   • I will commit to the new changes and get it finally reviewed.
4. First Month Evaluation - 3 days (Week 4):
   • Second Month Evaluation Period.

Phase 3 (17th June - 14th July): Review for usability and design also, implement information architecture for structure, discoverability, and maintainability

1. Information gathering - 8 days (Week 1, 2):
   • Review all documentation listed in this section for usability, accessibility, design, and SEO simultaneously keeping notes for every step so that new contributors can get an overview of the process from the documentation.
   • Setup
2. Doc writing Period - 14 days (Week 2, 3):
   • Start work on information architecture (organization/structure).
   • This period includes implementing designs, usability, accessibility, and SEO.
3. Review - 5 days (Week 3):
   • I will work on the requested changes.
   • I will commit the new changes and get it finally reviewed.
4. First Month Evaluation - 3 days (Week 4):
   • Third Month Evaluation Period.

Budget

I am proposing a budget of $7,000 for the entire project, in line with the outlined timeline, deliverables, and scope.

Additional Information

Working Hours

I can devote 25-30 hours per week.

Why I’m best to complete this Project

• I have a good understanding of the technology required in the project which is MediaWiki and Wikitext. As a result, it will not take much time for me to understand the code and functionality of the product.
• I have contributed to open source and used git, Github, and GitLab as a medium.
• I have a good understanding of markdown files.
• I am passionate about technology, and learning and documenting it will help me to boost my skills as well.
• I can complete the doc under the given timeline.