Page MenuHomePhabricator

WMAHack25: Wikimedia Tool Documentation
Closed, ResolvedPublic

Description

This Hackathon project encourages participants to write user-friendly/developer documentation for tools (gadgets, user scripts, web apps, etc). It also includes tasks for improving the information about tools in Toolhub.

For each tool, the participants will:

  • Walk through the tool and experiment the functionality
  • Write a user documentation for the tool
  • Provide a report if the tool doesn't work or is not supported.

This task features the request for documentation for the following:

Event Timeline

Eugene233 renamed this task from WMAHack25: Wikimedia Tool Documentation in African Languages to WMAHack25: Wikimedia Tool Documentation.Mar 29 2025, 7:35 AM
Eugene233 updated the task description. (Show Details)
Eugene233 updated the task description. (Show Details)

@Aklapper sorry let me move them to the mainspaces. These docs when created, will be linked to their respective toolhub records. Also, there's a template for them to follow. Then when they are done, they can link it to the toolhub record of that tool.

For {T:390352}, There's an ongoing discussion about this so I am going to hold on to this task for now. But move the other tasks to the parental pages.

@JorisDarlingtonQuarshie I suggest that hackathon participants should create the documentation drafts in their User spaces, and then they can engage with the tool maintainers about integrating what they wrote into existing tool documentation or tool records.

I have just added a new task to the list since we got a request from one of the tool creators for Adiutor, they would love if the documentation for that tool could be put in the format of the tool doc template (https://www.mediawiki.org/wiki/Documentation/Tool_doc_template) we are using: more info in T390392.

Je viens de crée une version de la page modèle en francais: https://www.mediawiki.org/wiki/Documentation/Tool_doc_template/Fr
J'espère que cela vous aidera!

Summary of activities:

Participants created draft technical documentation using the Tool Doc template. They learned to edit wiki pages, use Phabricator, and collaboratively edit drafts in a User space page. At the end of the Hackathon, they were given instructions for how to reach out to tool maintainers to start a discussion about integrating their draft content into existing tool pages.

Docs created by Technical Documentation teams:

Page Collection Report (T390354) - Team 10:

WikiBooster (English:T390353, French:T390459) - Team 11:

A search engine for translations from the English Wiktionary (T390456) - Team 12:

Book Linker tool (T390351) - Team 13:

Translat-a-thon (English docs T390387, French docs T390393) - Team 14:

Citation Toolkit (T390356) - Team 15:

TBurmeister changed the task status from Open to In Progress.Apr 2 2025, 4:36 PM
TBurmeister claimed this task.