Page MenuHomePhabricator

Consolidate MediaWiki Help Documentation
Closed, DeclinedPublic

Description

Personal information

Name: Areesha Tariq
Email: areeshatariq02@gmail.com
Availability: 40 hours per week

Professional information

Portfolio: Areesha Tariq Portfolio
Resume: Areesha Tariq Resume
Blog: Areesha Tariq blog

Overview of my recent Technical Writing Experience:

  • I have participated as a technical writer in Google Season of Docs 2020 for the organization Diffusion Imaging in Python (DIPY). I created documentation to show how Command Line Interface workflows can be used to process diffusion-weighted MRI data. I also worked on improving the consistency across the documentation to make it easier to understand and maintain. Project Report: GSoD DIPY Report
  • I have participated as a technical writer in Google Season of Docs 2019 for the organization OpenELIS Global. I did the end-user documentation for the OpenELIS system. The existing documentation of the system was in French, I translated it into English and updated the documentation. I restructured the documentation and updated it according to the latest version of the system for easy navigation. Project Report: GSoD OpenELIS Global Report
  • In April - Aug 2020 , I worked as a backend developer in Outreachy. Along with the development work, I documented Open Food Facts modules in the perlpod (POD) format.
  • I have worked as a Technical content engineer for 3 years in Educative.io, a platform to teach technical courses to software engineers and technical writers. During my job, I have created many technical and interactive courses, user guides, manual instructions, and project descriptions. Apart from that, I reviewed many outdated courses and updated the documentation. Following are the links of some of the courses that I made:
  • Developing Web Applications with PHP - AI-Powered Learning for Developers
  • Learn Coding Basics in JavaScript - AI-Powered Learning for Developers
  • Python for Scientists and Engineers - AI-Powered Learning for Developers

Project statement

Project Title: Consolidate MediaWiki Help Documentation - The Wikimedia Foundation

Description
For this project, I propose to tackle the challenge outlined by the Wikimedia Foundation regarding the consolidation of MediaWiki documentation scattered across Meta-Wiki and MediaWiki.org.
My Approach
My approach involves a systematic review and comparison of existing documentation on both platforms, identification of missing or duplicated content, and the creation of new documentation where necessary. To address the problem of duplicated or disconnected documentation, I will first analyze pages listed under the designated categories on Project:MediaWiki documentation on Meta-Wiki/List. For pages with equivalents on MediaWiki.org, I will compare the content, update missing information, and ensure consistency across platforms. In cases where there is no equivalent on MediaWiki.org, I will create new pages to cover the relevant content. Furthermore, I will pay special attention to documentation specific to Wikimedia projects, ensuring that such content remains on Meta-Wiki while minimizing duplication between the two platforms. This approach will streamline access to information for MediaWiki users, facilitating better utilization of the documentation and reducing maintenance overhead for documentation writers. Throughout the project, I will maintain close communication with members of the Wikimedia Foundation's Technical Documentation team to gather insights, address queries, and incorporate feedback. This collaboration will ensure alignment with organizational goals and enhance the effectiveness of the documentation consolidation efforts.

Proposed timeline

Project Kickoff and Onboarding (May 20 - June 1)

  • Set up accounts and access to necessary tools such as Meta-Wiki and MediaWiki.org.
  • Familiarize myself with the project plan, goals, and requirements.
  • Establish communication channels with project members and stakeholders.
  • Review existing documentation and guidelines for Meta-Wiki and MediaWiki.org.
  • Review list of Meta-Wiki pages for consolidation.
  • Plan approach for de-duplication and content creation.
  • Compile initial list of Meta pages with equivalents by reviewing pages on Project:MediaWiki_documentation_on_Meta-Wiki/List#Has_MediaWiki.org_equivalent.

Phase 1 - De-duplication (June 2 - June 29)

  • Identify Meta pages with equivalents on MediaWiki.org and missing information.
  • Compare content between Meta and MediaWiki.org pages.
  • Update MediaWiki.org pages with any missing content.
  • Determine which content is specific to Wikimedia projects and should remain on Meta-Wiki.
  • Write content needed for MediaWiki.org
  • Take feedback on the content written for MediaWiki.org
  • Finalize updates to MediaWiki.org pages.
  • Publish the content
  • Prepare summary of Phase 1 findings and actions taken.
  • Address any remaining discrepancies between Meta and MediaWiki.org pages.
  • Document any remaining Wikimedia-specific content on Meta-Wiki.
  • Review Meta-Wiki pages listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#No_MediaWiki.org_equivalent

Phase 2 - New Content (June 30 - August 31)

  • Review Meta-Wiki pages listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#Actually_WMF-specific
  • Group Meta-Wiki pages into subject areas for systematic review.
  • Audit each subject area to identify pages that need new information to be added to MediaWiki.org
  • Identify information that is specific to Wikimedia and should stay on Meta
  • Identify areas on Meta-Wiki lacking equivalents on MediaWiki.org
  • Write documentation for Meta-Wiki pages without equivalents
  • Incorporate feedback from project members and stakeholders to refine the newly created documentation.
  • Publish the updated content on MediaWiki.org.

Phase 3 - Organization (September 1 - October 5)

  • Review the remaining Wikimedia-specific content on Meta-Wiki.
  • Develop an information architecture to organize Meta-Wiki content effectively, ensuring easy discoverability and maintenance.
  • Gather feedback from project members and stakeholders on the proposed information architecture.
  • Implement changes and updates to meta:Help based on the finalized information architecture.

Project Wrap-up (October 6 - October 26)

  • Complete any remaining cleanup tasks, such as reviewing and revising outdated or obsolete documentation.
  • Identify any follow-up work, additional tasks and potential areas for improvement required to ensure the long-term sustainability of the documentation consolidation efforts.
  • Write a comprehensive project report detailing the outcomes, learnings, best practices, and recommendations for future projects.
  • Finalize and publish the project report for stakeholders and the wider community.

Expectations for participation and feedback:

  • Timely responses to queries.
  • Regular check-ins with project members to discuss progress and address any challenges.
  • Collaboration in reviewing and providing feedback on draft documentation to ensure accuracy and relevance.

Proposed Budget: $12000

Event Timeline

Pppery renamed this task from Consolidate MediaWiki Help Documentation - The Wikimedia Foundation to Consolidate MediaWiki Help Documentation.Apr 18 2024, 6:19 PM
apaskulin moved this task from To review to Reviewed on the Google Season of Docs 2024 board.
apaskulin subscribed.

Hi @Areeshatariq, Thanks for your interest in Season of Docs! I really like the detail you put into your proposal, especially in the timeline. 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.

Hi @Areeshatariq, Unfortunately, we haven’t selected your proposal for this year’s Season of Docs. We had so many great applications; it was a tough decision. We hope you’ll consider applying next year. If you’re interested in contributing to Wikimedia documentation as a volunteer, check out Documentation/Contribute. If you’d like more specific feedback on your proposal, feel free to send me an email at apaskulin@wikimedia.org. Thanks again for your interest!