Page MenuHomePhabricator

Technical writer statement of interest
Closed, DeclinedPublic

Description

Personal information

Name: Neelima Mohanty
Email: neelimagoogly@gmail.com
Github
Social Handles: Twitter, Linkedin
Blog
Location: India (GMT+5:30)
Typical working hours: Between 6 am and 12 pm GMT +5:30
Available Working Hours Per Week: 50 Hours

Professional information

Myself Neelima Mohanty, hereby showing my interest to be hired through Google Season of Docs 2024 as a technical writer for the project ‘Consolidate MediaWiki Help Documentation - The Wikimedia Foundation’ .
After going through the project proposal, I compared my technical writing skillset with those required by this project and according to me they are a match. And I would like to highlight this match to you by comparing them through the table below. (Links to my work are in blue)

Skill RequiredMy Experience
Technical Writing Experience• Worked as a technical writer intern at Humanitarian OpenStreetMap Team as an Outreachy(which is an Open Source Program) Intern .
• Created the documentation for FMTM(Field Mapping and Tasking Manager) .
• Created the documentation for OSM-FIELDWORK Project.
• Created API Docs for FMTM and OSM-Fieldwork .
• Also improved the documentation for fAIr project of HOTOSM which is an AI Mapping Tool.
• Also delivered a Lightning Talk about FMTM at Code for All Summit 2023 with my team during the internship.
• Created Separate Tutorials and User Guides for various roles Field Mapping Mappers,Mapping Managers and Vadidators.
Certificate of Completion
Letter of Recommendation by my mentors
• Wrote many technical blogs covering various topics related to software.
• I have written for two technical blog websites :
o OSM Diary o Techworm
Experience as an open source technical writer and contributorOutreachy is an open source program and I was a contributor for Humanitarian OpenStreetMap team for 2 months . On the basis of my contributions during the Outreachy contribution phase , I was selected as an Technical Writer intern at HOTOSM. • Certificate of Completion

Along with this my mentors Petya Kangalova and Rob Savoye have sent me a Letter of Recommendation by my mentors . Please click on the this link to view this letter.
I request you to please go through the above table and I am sure you too will find that I have the skills required for this project. I will be really grateful to you if you give a chance to prove my skills in the interview at least. Although I know I do not have an experience of being a technical writer for 10 or more years but all my skills are apt for this project and all these years since when I joined Computer Science Engineering, I have had a dream of being a technical writer. Please consider my technical writing abilities and give me a chance.

Project statement

Project title
Consolidate MediaWiki Help Documentation

Synopsis
MediaWiki.org is the documentation wiki for MediaWiki: an open-source wiki platform used by Wikipedia and other Wikimedia projects, as well as by many other organizations and projects.

Detailed description
Before MediaWiki.org existed, MediaWiki documentation was stored on a different wiki: Meta-Wiki (also called Meta). Since MediaWiki.org was established as the official wiki for MediaWiki documentation, most MediaWiki documentation pages on Meta have been moved to MediaWiki.org.

However, there are still some pages on Meta that contain MediaWiki documentation. In most cases, these pages cannot be imported directly to MediaWiki.org because of licensing restrictions or because a corresponding page already exists on MediaWiki.org. This duplication makes it harder for users of MediaWiki to find the information they need and harder for documentation writers to maintain the docs, and as a result, the Meta pages have often become very outdated.

Some documentation on Meta relates to MediaWiki but is specific to how MediaWiki is used on Wikimedia projects. This content should stay on Meta, while duplication between the two wikis should be reduced as much as possible.

The scope of this project includes:
For pages listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#Has_MediaWiki.org_equivalent, compare the Meta page with its MediaWiki.org equivalent, and add any missing information to the MediaWiki.org page.
For pages listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#No_MediaWiki.org_equivalent, create a MediaWiki.org page that covers the content on the Meta page.
For pages listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#Actually_WMF-specific, review the pages for usability, and design and implement an organization to make these pages easy to discover and maintain.
Project Goal
The project aims to achieve the following goals

Reduce the number of pages that need to be moved to MediaWiki.org (either partially or completely) from 82 to 0.
Organize the MediaWiki-related pages remaining on Meta to make them easier to use and maintain.

My Solution/Approach
I will follow the steps below to solve the problem :

  1. Audit each Meta page, identify its MediaWiki.org equivalent,any information that needs to be added to the MediaWiki.org page and any information that is specific to Wikimedia and needs to stay on Meta.Write the required content.
  2. Audit pages in each subject area, and identify,any information that needs to be added to MediaWiki.org where the information should be added in context of the related MediaWiki.org documentation and any information that is specific to Wikimedia and needs to stay on Meta . Write the required content .
  3. Review Wikimedia-specific content on Meta, including content in this category identified during steps 1 and 2 and design an information architecture for this content

With my previous open source experience as a technical writer in Outreachy , auditing , redefining the documentation and arranging them without having duplicates was part of my job , so I am confident I will complete this project pretty well if given a chance.

Proposed Timeline

Period Task
Phase 1: May - June Information Gathering

  • Review the Project: MediaWiki documentation on Meta-Wiki/List to identify pages requiring migration or restructuring.
  • Gather information on the content and structure of the documentation to be migrated or created.
  • Compile a comprehensive list of pages that need to be migrated.
  • Create a detailed plan outlining the approach for migrating and restructuring the identified pages.

Phase 2: July - September Content Creation

  • Write and edit documentation for MediaWiki.org based on the identified needs and the compiled list of pages
  • Compare the Meta page with its MediaWiki.org equivalent, and add any missing information to the MediaWiki.org page.
  • Create a MediaWiki.org page that covers the content on the Meta page.
  • Review the pages for usability, and design and implement an organization to make these pages easy to discover and maintain.
  • Create new documentation pages as needed, focusing on clarity, completeness, and relevance to users.
  • Ensure adherence to licensing restrictions and accuracy of information during content creation.
  • Regularly update progress reports to track the completion status of each documentation page.

Phase 3: October Review and Feedback

  • Seek feedback from project mentors on the drafted documentation and make necessary revisions for clarity and completeness.
  • Incorporate feedback promptly and make necessary revisions to ensure clarity, accuracy, and completeness of the documentation.
  • Conduct thorough reviews to address any potential issues or gaps identified during the feedback process.

Phase 4: November Final Review and Publication

  • Finalize and publish the migrated and newly created documentation on MediaWiki.org.
  • Ensure seamless integration of the documentation into the existing structure of MediaWiki.org.
  • Perform quality assurance checks to verify the accessibility and discoverability of the published documentation.
  • Provide documentation and guidance on maintaining and updating the published content for future reference.

Budget

Technical writer audit, write, organize, and publish content to consolidate MediaWiki help documentation 12000.00

Event Timeline

apaskulin subscribed.

Hi @Neelimagoogly, Thanks for your interest is Season of Docs! I like the detail you've put into the timeline section of your proposal. 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 @Neelimagoogly, 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!