968736 - [meta] Documentation status pages for MDN content areas

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: General, defect, P2)

Description

[Florian Scholz (Open Web Docs)]

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?"

Comment 1

[Florian Scholz (Open Web Docs)]

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.

Comment 2

[Florian Scholz (Open Web Docs)]

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.

Comment 3

[Florian Scholz (Open Web Docs)]

* 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.

Comment 4

[Florian Scholz (Open Web Docs)]

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.

Comment 5

[Florian Scholz (Open Web Docs)]

> 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.

Comment 6

[Florian Scholz (Open Web Docs)]

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.

Comment 7

[Florian Scholz (Open Web Docs)]

Blog post about 1.0 milestone:
http://florianscholz.com/2014/03/arewedocumentedyet/

Also, this is the landing page now:
https://developer.mozilla.org/en-US/docs/MDN/Doc_status

Comment 8

[Jean-Yves Perrier [:teoli]]

The phase 1 was the only large scale phase. We are adding needed pages little by little.