bugzilla.mozilla.org has resumed normal operation. Attachments prior to 2014 will be unavailable for a few days. This is tracked in Bug 1475801.
Please report any other irregularities here.

[meta] Documentation status pages for MDN content areas

RESOLVED FIXED

Status

Developer Documentation
General
P2
normal
RESOLVED FIXED
5 years ago
3 years ago

People

(Reporter: fscholz, Assigned: fscholz)

Tracking

(Depends on: 4 bugs)

Details

(URL)

(Assignee)

Description

5 years ago
This bug tracks work for the documentation status pages project.

Goal: Each content area will show the health of sub-pages and work to be done. It will include a summary and a collection page shows metrics for all content areas in a single place.

This project is supporting these goals:
* Improving quality of content / maintainance
* Evaluating priorities in the content areas
* Growing contribution & community (1M Mozillians, 1K Dev Contributors) aka "What can I do for MDN?"
(Assignee)

Updated

5 years ago
Assignee: eshepherd → fscholz
Priority: -- → P2
(Assignee)

Updated

5 years ago
Depends on: 963811
(Assignee)

Updated

5 years ago
Depends on: 951775
(Assignee)

Comment 1

5 years ago
All documentation status pages are tagged with "Documentation status". The list can be found at:
https://developer.mozilla.org/en-US/docs/tag/Documentation%20status

Not all existing doc status pages offer a summary with metrics yet and not all content areas have a doc status page. More to come as more content areas are clear.
(Assignee)

Comment 2

5 years ago
Metrics / health indicators we already have (implemented using KumaScript macros):
* Pages with no tags
* Pages with Needs* tags (NeedsExample, NeedsCompat, NeedsContent, ...)
* Pages needing editorial reviews
* Pages needing technical reviews
* List of dev-doc-needed bugs for that content area
* List of doc request bugs for that content area
* Custom metrics like "pages cleaned up" (custom todo list that is trackable, could also be "pages migrated" or more)
* Missing pages: A list is present for CSS but needs to be expanded (if possible) for other areas.
(Assignee)

Comment 3

5 years ago
* Pages not being updated in a long time.

The macro for finding the page age is already written but is waiting for bug 968745. You are able to define a compare date that says what is "old" and that date might differ from content area to content area.
Depends on: 968745
(Assignee)

Comment 4

5 years ago
Another step accomplished today: Localizations!

For example:
https://developer.mozilla.org/en-US/docs/Web/CSS/Documentation_status/fr
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Doc_status/ja

The information whether a page is outdated or not is not yet available to all docs, but will be as soon as bug 968745 is fixed. 

What else do we need? 

* A visit counter to prioritize what to translate first (useful metric for English doc status as well). Maybe we could get that through the Google Analytics API in KumaScript. I will ask our developers.
(Assignee)

Updated

5 years ago
Depends on: 973612
(Assignee)

Comment 5

5 years ago
> What else do we need? 
> 
> * A visit counter to prioritize what to translate first (useful metric for
> English doc status as well). Maybe we could get that through the Google
> Analytics API in KumaScript. I will ask our developers.

Filed in bug 973612.
(Assignee)

Updated

4 years ago
Depends on: 978073
(Assignee)

Updated

4 years ago
Depends on: 982942
(Assignee)

Comment 6

4 years ago
I would call the first iteration now completed (q1 goal reached).

The follow sections have documentation status pages (12):
* Accessibility
* API
    Subgroups (14): 
    * CSSOM
    * Device APIs
    * DOM
    * File API
    * HTML API
    * IndexedDB
    * SVG API
    * WebAudio
    * WebComponents
    * WebCrypto
    * WebRTC
    * WebSockets
    * WebStorage
    * WebWorkers
* Apps
* CSS
* DevTools
* Firefox OS
* Games
* HTML
* JavaScript
* Marketplace
* MathML
* SVG

There are localization status pages most of the above sections for the languages (7):
* Deutsch - de
* Español - es
* Français - fr
* 日本語 -ja
* Polski - pl
* Português (do Brasil) - pt-BR
* 中文 (简体) - zh-CN

The doc status pages we have are monitoring around 40% of all MDN pages. That means 60% percent has still to be sorted through and doc status pages have to be considered for more areas. But our TIER-1 content should already be tracked with what we have right now.

Over time these pages will of course improve further and if the dependencies of this bug are fixed, we can even measure more data. That is phase two then.
(Assignee)

Updated

4 years ago
Depends on: 998346
(Assignee)

Updated

4 years ago
Depends on: 1064796
The phase 1 was the only large scale phase. We are adding needed pages little by little.
Status: NEW → RESOLVED
Last Resolved: 3 years ago
Resolution: --- → FIXED
(Assignee)

Updated

3 years ago
Depends on: 1223014
You need to log in before you can comment on or make changes to this bug.