Page MenuHomePhabricator

Integrate guidance in Doc Metrics prototype docs with Documentation Toolkit
Closed, ResolvedPublic

Description

As part of providing guidance for how to use the Doc Metrics, I found myself writing instructions that should probably, ultimately, be part of the Documentation Toolkit:

These pieces of content are basically checklists that, in some cases, link to the doc templates in the Toolkit as a reference for how to assess page structure, page contents, etc. These instructions should probably be integrated into the review checklists, or somehow maintained as part of the Toolkit rather than being embedded in the doc metrics prototype page, since their relevance goes beyond just using and interpreting the doc metrics data -- these are core tech writing practices and tactics.

Once we determine where this content should live, the links and sections in https://www.mediawiki.org/wiki/Documentation/Tools/Metrics_generator can be updated to instead point there.

Event Timeline

TBurmeister changed the task status from Open to Stalled.Jun 19 2025, 3:01 PM
TBurmeister triaged this task as Low priority.
TBurmeister updated the task description. (Show Details)

I proposed changes to the Tech Docs team that would evolve our doc review checklists to incorporate this information, but we weren't able to come to a consensus about whether this content is too complex to be included in the Toolkit, or whether it can be useful to people in checklist form. To move this forward, we probably need to do some user testing to get more understanding of what types of doc review tasks are approachable and actionable for the various target audiences of the Doc Toolkit.

Drafts of revised Doc Toolkit section and my proposed new structure and checklists that include the expanded "in-depth" review sections:
https://www.mediawiki.org/wiki/User:TBurmeister_(WMF)/Sandbox/Toolkit
Which links to the following pages which, for now, are using transclusion to show how the content in https://www.mediawiki.org/wiki/Documentation/Tools/Metrics_generator could look if located within the review checklists:

Content at https://www.mediawiki.org/wiki/Documentation/Toolkit#Improve_individual_docs is now updated, new subpages created or existing ones revised, and https://www.mediawiki.org/wiki/Documentation/Tools/Metrics_generator is transcluding content from those review checklists instead of acting as the home for it.