This project will identify which metrics are relevant for MediaWiki Core documentation, how we can use those metrics to drive our technical documentation work, and how they can help us identify areas for improvement.
Motivation: Measuring the health of our technical documentation can help us assess the developer experience and the state of the Wikimedia technical ecosystem. We want to measure doc health because documentation is a core component of the developer experience. This project seeks to explore and define:
- What questions in the field of developer/engineering workflows (see WE6) have a component that can be answered by documentation metrics?
- What type of documentation data can help enable informed decision-making about how to improve developers' experience?
One expected outcome of this work is a clearer definition and shared understanding of what it means to drive tech docs work with data in the Wikimedia context, and how we can start to build a measurement approach that we can apply to docs in various Wikimedia technical domains (i.e. beyond MediaWiki core)
Goals:
- Define an initial set of documentation health metrics for MediaWiki core technical documentation.
- Implement the metrics for a pilot subset of MediaWiki core docs.
Full project documentation:
https://www.mediawiki.org/wiki/Wikimedia_Technical_Documentation_Team/Doc_metrics