Page MenuHomePhabricator

[Documentation] Write user docs for Translat-a-thon tool
Closed, ResolvedPublic

Description

This task involves creating on-wiki documentation for the Translat-a-thon tool

This tool is listed in Toolhub under https://toolhub.wikimedia.org/tools/toolforge-dicare ( a set of tools).

Steps:

Explore the tool: Click the "Go to Tool" button on its Toolhub page.

Note: Please use this wiki-text template: https://www.mediawiki.org/wiki/Documentation/Tool_doc_template

Create on-wiki docs:

  • In your user space, create a new subpage (for example https://meta.wikimedia.org/wiki/User:{YOUR USERNAME}/New_page
  • Write clear user guides (e.g., installation, troubleshooting).
  • Get feedback from another hackathon participant - have them review your documents and provide suggestions.
  • Reach out to the maintainer of the tool to tell them about your documentation and suggest publishing it with the tool. You need to work with the tool maintainer to decide where they want to publish the documentation.

Use this guide to help you! https://www.mediawiki.org/wiki/Documentation/Tool_docs
Skills Required: Technical writing, MediaWiki editing, Toolhub navigation.

Event Timeline

Please, someone to create the ticket for those who wish to work or translate this tech-doc in french?

Umabruka changed the task status from Open to In Progress.Mar 29 2025, 7:49 PM
Umabruka subscribed.

@Bile_rene tache pour traduction | the task for translating these tool docs: T390393

anyone started here please share so we can contribute

https://meta.wikimedia.org/wiki/User:Mudeh_Dieudonne_Mukum/Dicare-tool . Access the link to see what I came up with feel free to access and edit for better result

I included some punctuation and spelling edits

Great job during the Hackathon, everyone! If you want to keep learning and keep contributing to technical documentation, here are instructions: https://www.mediawiki.org/wiki/Documentation/Contribute.

If you want to reach out to the maintainers of the tool you documented, to talk to them about where to add what you wrote in "official" documentation for the Translat-a-thon tool, I suggest you should:

Thanks again for your amazing work this weekend.