In T386254, we analyzed the outputs of the doc metrics test (T379431), and got user feedback. Based on what the metrics test revealed about the utility and validity of various data sources, we'll now choose the best candidates and implement a prototype that enables those metrics to be calculated and displayed for a given input list of mediawiki.org wiki pages.
Description
Description
Details
Details
Related Changes in GitLab:
| Title | Reference | Author | Source Branch | Dest Branch | |
|---|---|---|---|---|---|
| Move input list to the top for easier use and fix decimal point output | repos/technical-documentation/doc-metrics-testing!7 | tburmeister | cleanup | main | |
| Implement final metrics calculations and output data to csv | repos/technical-documentation/doc-metrics-testing!5 | tburmeister | prototype | main | |
| Get edits data from Analytics API | repos/technical-documentation/doc-metrics-testing!4 | tburmeister | prototype | main | |
| Add first version of the prototype | repos/technical-documentation/doc-metrics-testing!2 | kbach | prototype | main |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | TBurmeister | T372099 [FY2024-25] WE6.1.2 Research available Documentation Metrics | |||
| Resolved | TBurmeister | T388141 Implement prototype for metrics calculations |
Event Timeline
Comment Actions
Aspirational/draft timeline:
- By March 7: finalize which metrics to implement in prototype
- March 10 - 14: implementation sprint
- March 14 - 21: share out and invite stakeholders to experiment with the prototype
- March 24 -31: plan any follow-up or related work for Q4 and beyond
Comment Actions
kbach opened https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/2
Add first version of the prototype
Comment Actions
tburmeister merged https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/2
Add first version of the prototype
Comment Actions
tburmeister opened https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/3
Update prototype to include revisions data and use dataframe for output
Comment Actions
tburmeister opened https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/4
Get edits data from Analytics API
Comment Actions
tburmeister merged https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/4
Get edits data from Analytics API
Comment Actions
tburmeister opened https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/5
Implement final metrics calculations and output data to csv
Comment Actions
tburmeister merged https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/5
Implement final metrics calculations and output data to csv
Comment Actions
Progress update:
- Metrics prototype code is fully implemented, and the script can be run locally to generate a CSV of metrics scores.
- To enable easier use, I want to provide this as a PAWS notebook that anyone can fork and run, but I wasn't able to complete that work this week.
Goals for next week:
- Tidy up the code and make usability improvements based on team feedback.
- Finalize the PAWS notebook version of the script.
- Finish documentation and share the prototype with stakeholders.
- Close out this task!
Comment Actions
tburmeister opened https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/7
Move input list to the top for easier use and fix decimal point output
Comment Actions
Wrapping up this task!
- Sent a final MR to clean up some of the output and make it more user-friendly. Since those are just UX finesse, I will not consider that MR blocking for me to resolve this task and close out the Hypothesis.
- PAWS notebook created and published: https://public-paws.wmcloud.org/User:TBurmeister_(WMF)/doc_metrics.ipynb
- Documentation updated: https://www.mediawiki.org/wiki/Wikimedia_Technical_Documentation_Team/Doc_metrics/Prototype
Anyone is now welcome to use the script/notebook to generate and use metrics to help with technical documentation improvements and prioritization.
Comment Actions
tburmeister merged https://gitlab.wikimedia.org/repos/technical-documentation/doc-metrics-testing/-/merge_requests/7
Move input list to the top for easier use and fix decimal point output