WikiIndaba 2024/Proposal/Doc Your Tool: Building Stronger Communities Through User-Friendly Documentation

ID :
Author(s): Joris Darlington Quarshie, Abigail Afi Gbadago	Username(s): Joris Darlington Quarshie , Afimaame	Session type: Workshop
	Affiliation: African Wikimedia Technical Community	Session track(s): Research , Education & Technology
Abstract: The "Doc Your Tool" project empowers WikiIndaba Hackathon 2024 participants to create user-friendly documentation for valuable tools and projects. This session will explore two main approaches: 1. Documenting as you develop and documentation-driven development. Participants will learn how clear and concise documentation can increase project adoption, 2. Improve tool sustainability, and foster a collaborative learning environment. NB: This project started off at the Wikimedia Hackathon 2024 which we are looking forward in running this project across the Wikimedia Hackathon,Wikimania Hackathon and WikiIndaba Hackathon. The documentation page for this project can be found below: Project Documentation Page We have already exisiting tasks that we look forward in completing during this workshop at Wikiindaba 2024 1.⁠ ⁠Documentation: Fix local setup documentation for gdrive-to-commons 2.⁠ ⁠⁠Find and fix inaccuracies in Toolforge Django tutorial 3.⁠ ⁠⁠Stewardbots README.md is outdated 4.⁠ ⁠⁠Improve documentation of Wikidata periodic table 5.⁠ Source code and basic documentation missing for Fountain edit-a-thon tool hosted on Wikimedia Toolforge		Audience : Basic
		Mode: In-person
		Special requirements: Translation

How will this session be beneficial for the communities in the region? 1. Increased Visibility and Impact: Improved documentation leads to wider adoption of African-developed tools within the Wikimedia community, extending their reach and influence. 2. Knowledge Sharing and Capacity Building: The session will provide a platform for knowledge sharing and mentorship between experienced technical writers and beginners, fostering a strong technical writing community within Africa. 3. Enhanced Tool Sustainability: By equipping participants with documentation skills, they can ensure that valuable African-developed tools can be maintained and improved by others in the community. 4. Community Contribution: The session will empower participants to directly contribute to the Wikimedia knowledge base and infrastructure by creating high-quality documentation for African-developed tools.

Interested participants

(register below and ask your questions now to the session organiser)