Page MenuHomePhabricator

Identify and define doc collections for v0 metrics testing
Closed, ResolvedPublic

Description

This task builds on the v0 metrics definitions defined during the work outlined in T372102.

  • Research: Define the scope of content to measure with v0 proposed tech docs metrics. Resolve RQ3.
  • Design: Use either developer workflows, MediaWiki core code structure, or some other logical framework to identify several content collections to measure.
  • Implement: Use PagePile or other mechanism to create collections.

Target completion date: October 30, 2024

Event Timeline

TBurmeister changed the task status from Open to In Progress.Sep 30 2024, 6:00 PM
TBurmeister triaged this task as Medium priority.

As of Q1 FY24/25, the primary mechanisms for grouping MediaWiki documentation into collections appeared (to me) to be:

Hub and "table of contents" pages (these only help with navigation and conceptual grouping, not with assessing the linked pages as a collection):

Categories:

PagePiles:

  • Tech writers had previously created 4 PagePiles to capture collections on mw.org: https://www.mediawiki.org/wiki/Documentation/Collections. PagePiles enable us to use https://techdoc-dashboard.toolforge.org/ to view collection-level doc metrics. The Tech Docs dashboard may eventually support the inclusion of pages from different wikis within one collection/PagePile, but it does not yet do that (afaik).
  • This week, I started creating more PagePiles to capture MediaWiki doc collections. I created one collection for the ResourceLoader docs, based on manual content analysis. Then, I figured out how to use Quarry to get a list of titles by category, so I can use my Quarry query as an input for PagePiles, and then get doc metrics for that grouping of pages. I created collections for pages in the mw.org categories MediaWiki_introduction and Installation. For links to the dashboard pages for those collections, see https://www.mediawiki.org/wiki/Documentation/Collections

I am continuing to do testing and assessment of how I as a tech writer would use this (and other dashboards) to help identify the quality of a doc collection and where improvements might be most impactful. In the coming weeks I'll be assessing some collections manually and then repeating the task using existing data sources, with the goal of determining gaps and opportunities for future metrics implementation.

TBurmeister updated the task description. (Show Details)

The collections I've identified for doc metrics testing and implemented as PagePiles are listed at https://www.mediawiki.org/wiki/Wikimedia_Technical_Documentation_Team/Doc_metrics/Research#RQ3:_Outcomes.

Next week I will add additional documentation to the project pages on-wiki describing how I chose those collections and why, along with the sources and prior work I considered along the way.