Wikimedia Technical Documentation Team
|
Wikimedia Technical Documentation
Empower people to use and contribute to Wikimedia technology by making technical documentation easy to find, use, create, and maintain.
|
This page documents the work and processes of the Wikimedia Foundation Technical Documentation Team (Tech Docs Team).
Mission
[edit]Our mission is to empower people to use and contribute to Wikimedia technology by making technical documentation easy to find, use, create, and maintain.
The document or site works when target users can find what they need, understand what they find, and act on it confidently.—"Five Steps to Plain Language", centerforplainlanguage.org
Open-source software is an essential part of the Wikimedia movement. It provides platforms for content, enables us to expand our reach, and encourages us to look at knowledge in new ways. Documentation is the method through which software can be shared, and built collaboratively[1]. Our mission is to ensure that everyone who wants to use or contribute to Wikimedia software can easily find and use the information they need. This work builds on over 20 years of technical documentation by the Wikimedia technical community. It strives to make technical information more accessible, more inclusive, and more reliable so that open-source software can continue to empower the Wikimedia mission.
Contact us
[edit]- Leave a comment on Talk:Documentation or Talk:Wikimedia Technical Documentation Team
- Tag a Phabricator task with #Tech-Docs-Team. You can use this tag to request a consultation (template) or review (template) from our team for a documentation project you're working on.
- Email us at techdocs
wikimedia.org - Talk to us in the #wikimedia-techdocs connect channel on libera.chat
Goals
[edit]Drive documentation work with data
[edit]Documentation success is notoriously difficult to measure. However, in order to prioritize our work and create a shared understanding of documentation quality, we must establish metrics, based on quantitative and qualitative methods, for measuring documentation health and tracking improvements.
Documentation effectively meets users’ information needs
[edit]Better understanding the health of our technical documentation across technical areas enables us to identify where the need for improvement – and potential for impact – is greatest. Technical writers provide documentation strategy to support critical user journeys across products and projects. Our holistic view of Wikimedia technical content helps us create and structure content for multiple, overlapping audiences. As partners in development workflows, technical writers provide a crucial user-focused perspective, helping improve our technology so that it needs less documentation.
Build the culture of documentation
[edit]The Wikimedia technical ecosystem spans hundreds of services, extensions, libraries, and tools, created by both staff and volunteers. To effectively manage technical documentation at this scale, we must empower Wikimedians across the movement to create and manage docs. This requires community outreach, self-service tools, and processes that support (and require) documentation updates. We must also invest in automated tools, like CI-based documentation checks and content linters, to make it easier for everyone to participate in maintaining great docs.
Active projects
[edit]For more details, read our updates on Talk:Wikimedia Technical Documentation Team, and visit our workboard on Phabricator.
| Project | Goal | Contact |
|---|---|---|
| Docs support for WDQS v2 onboarding and launch readiness | DE2.6.1 and DE2.6.3 | TBurmeister |
| Create and optimize conent for Developer Portal v2 | PP3.4 | APaskulin |
Past projects
[edit]- Publish user guide for Wikidata Query Service backend migration (completed September 2026)
- Design information architecture for Developer Portal v2 (completed September 2026)
- Productionalize API spec linting (completed July 2026)
- API Portal shutdown (completed June 2026)
- Implement API documentation patterns (completed April 2026)
- Unified changelog for Wikimedia APIs (completed March 2026)
- Lift Wing API documentation (completed March 2026)
- Security and authentication extension documentation (completed March 2026)
- Two-factor authentication (2FA) documentation (completed February 2026)
- Improve API changelog style guide (completed January 2026)
Maintenance projects
[edit]We maintain the following projects that align with our team goals. Maintenance responsibilities include reviewing patch requests, fixing critical bugs, monitoring wiki pages, and monitoring Phabricator projects.
Wikimedia Developer Portal
[edit]The Developer Portal is a static website that helps people find Wikimedia technical documentation. For more information, see the project documentation.
Documentation resources on mediawiki.org
[edit]Documentation and its subpages provide resources to help you find technical documentation, improve your docs or your writing, and get involved in contributing to Wikimedia technical documentation efforts.
API spec reader
[edit]The API spec reader is a tool that renders OpenAPI specifications with a built-in sandbox. For more information, see the project documentation.
MediaWiki Action API demos and app gallery
[edit]The mediawiki-api-demos repository contains sample apps for MediaWiki Action API tutorials, sample code for MediaWiki Action API docs, and code for the MediaWiki Apps Gallery.
doc.wikimedia.org
[edit]doc.wikimedia.org is a platform for Wikimedia technical documentation, including static sites and generated docs. We lead the documentation strategy for the platform.
JSDoc WMF theme
[edit]In partnership with WMF frontend teams, we co-maintain the Wikimedia theme for generated JavaScript documentation on doc.wikimedia.org, including leading documentation strategy, triaging and implementing minor fixes and enhancements, and releasing new versions.
Technical documentation dashboard
[edit]The technical documentation dashboard is a Toolforge tool that aggregates metrics about collections of documentation pages on wiki. See phab:T334839 and Documentation/Tools/Documentation metrics dashboard.
Documentation linter
[edit]A set of experimental tools used to analyze technical documentation and generate feedback on how to improve it. See Documentation/Tools/Linting and phab:T388109.
Doc metrics generator
[edit]An experimental tool that generates high-level doc metrics for pages on mediawiki.org. See Documentation/Tools/Metrics generator.
Team members
[edit]| Person | Timezone | Location | Developer account | IRC | Phabricator | Gerrit | GitLab |
|---|---|---|---|---|---|---|---|
| Alexandra Paskulin | UTC-8/-7 | California, USA | apaskulin | apaskulin | apaskulin | Alex Paskulin | apaskulin |
| Tricia Burmeister | UTC-5/-4 | Pennsylvania, USA | tburmeister | tburmeister | TBurmeister | Triciaburmeister | tburmeister |
| Kamil Bach | UTC+1/+2 | Belgium | kbach | kbch | KBach | KBach | kbach |
References
[edit]- ↑ "Documentation orients newcomers to open-source projects, helps them overcome technical and process barriers, and increases their self-efficacy". Balali, S., Steinmacher, I., Annamalai, U. et al. Newcomers’ Barriers. . . Is That All? An Analysis of Mentors’ and Newcomers’ Barriers in OSS Projects. Comput Supported Coop Work 27, 679–714 (2018). https://doi.org/10.1007/s10606-018-9310-8