Learning Area documentation status

This page tries to track ongoing documentation work in the MDN Learn section. Planning and actual work in progress is tracked on the on the community trello board.

Note: If you want to use the Trello board to organise yourself, just create a Trello account and ping Jeremie to have him give you write access to the board. To learn a bit more about how to use a Trello board, you can see how the content team uses its board with this article.

Summary

Pages No tags Needs* tags Missing tags Editorial reviews Technical reviews Outdated pages Documentation requests
205 1 (1%) 21 (11%) 47 (23%) 8 (4%) 6 (3%) 11 (6%) 9 (5%)

See also localization status of this section.

No tags

Found 1 pages. Learn more about how to tag pages.

Needs* tags

Found 21 pages. Learn more about how to deal with meta-tags.

Missing tags

At least missing one of the following: , , , , , , , , , , , , , , , , , ,

Found 47 pages. Learn more about how to tag pages.

Editorial reviews

Found 8 pages. Learn more about how to do an editorial review.

Technical reviews

Found 6 pages. Learn more about how to do a technical review.

Outdated pages

Found 11 pages. These pages haven't been updated in over a year. Outdated pages can have problems with both content and format. Look at these pages and consider: Is this page talking about the Web of today? Does it look consistent with newer pages in this topic area? If not, make any needed changes.

Documentation requests

Found 9 bugs. Documentation request bugs can contain various kinds work related to MDN pages. Read through the bug and ask questions in the bug if in doubt.

Bug Summary
993425 A new landing page for the Python Programming Language
1063999 Guide to text, text formatting and styling, and text rendering on the Web
1171753 "Common Pitfalls to avoid in Web Design" - this page is missing
1236263 Not able to configure arm emulation env
1249852 Incorrect documentation in Function definition
1255775 Some of the advanced level links are very old
1281266 Output of two lines of code is wrong in attached doc.
1298714 FTP is not the only way to upload files to a web server
1320420 Box model recap page refers to an example that is not shown

Browse as bug list.

Localizations

Please help us to localize this documentation into different languages. Read more about how to translate.

Language Pages Translated Translations up to date
af 152 0 (0%) 0 (0%)
bn-BD 152 2 (1%) 0 (0%)
de 152 11 (7%) 0 (0%)
es 152 25 (16%) 2 (8%)
fa 152 3 (1%) 0 (0%)
fr 200 86 (43%) 33 (38%)
it 152 6 (3%) 0 (0%)
ja 152 4 (2%) 0 (0%)
ko 152 18 (11%) 2 (11%)
pl 152 3 (1%) 0 (0%)
pt-BR 152 17 (11%) 2 (11%)
pt-PT 152 2 (1%) 0 (0%)
ro 152 2 (1%) 0 (0%)
ru 165 21 (12%) 5 (23%)
zh-CN 152 30 (19%) 12 (40%)
zh-TW 152 6 (3%) 1 (16%)

Writing priorities

Note: The actual work in progress and priorities are tracked on the community trello board

How to contribute

The learning area on MDN is brand new and offer a lot of opportunities for contribution from small tasks to large ones. Here's a list of all what you can do to help.

Writing learning articles

Expected time: A few hours

This is the core of the Learning Area. Those article are self teaching material which details a given skills to learn. A learning article focus on a single topic to learn and follow a strict structure which include. Read "Write an article to help learn about the Web" to learn how to structure such an article.

As an example, you can be inspired by the "Understanding URLs and their structure" article. See the Writing priorities section to know what is needed.

Creating "Active learning" material

Expected time: A few days

A TextBook article always need to be linked to some Active Learning materials. Those are projects, exercises, interactive code samples or everything that allows the reader to interact with a topic details into a TextBook. Such learning material is as important as any TextBook.

To create such Active Learning material, you are free to use any tools you wish. Nonetheless we strongly encourage you to use the WebMaker tools (especially Thimble) to do so as it provides various features very helpful for beginners and allows anyone to remix any content to learn from.

Creating learning pathways

Expected time: From a few hours to a few days

We also call them "learning tutorials". A learning pathways, explain how to complete a task and will link to all the necessary TextBook articles. As it is a pathways, it will also tell in which order the various TextBook need to be read to be able to complete the task. This is the backbone of the Learning Area as it provides guidance on what to learn first to do something.

Improve the glossary

Expected time: From a few minutes to a few hours

Our glossary is one of the key element for the Learning Area, see its dedicated doc status page for details on how to contribute.

Handle tagging

Expected time: From a few minutes to a few hours

Tagging is very important on the Learning Area. We should not have pages without tags. At minimum, a page in the Learning Area should have two tags:

Making editorial and technical review is also important. Remember that it's more important to be understood than to be technically perfect.

Get involved

Want to do more? Great, any one who wants to get involved with this project is welcome. Everything is discussed directly on the dev-mdc mailing list. A weekly meeting is held every Monday to discuss the progress and planning of the project.

Jeremie is the resource leading that project, feel free to contact him with any questions. He's available, for sure, on IRC every Monday (European time) on the various MDN channels (#mdn, #mdndev) and more.

Team

Goals

The overall goals of the project are:

  • Improve the discoverability of beginner contents: We have some existing contents but it is pretty hard to find. We need to organize it in a better way for beginners.
  • Improve the quantity of beginner contents: While writing we mainly focus on average and advanced users. As a consequence, we lack some serious beginner oriented contents. We need to write those missing contents and organize them with the existing contents to make easier for everybody to access and contribute to them.
  • Improve the quality of beginner contents: Still, we have some existing content for beginners but we need to organize it, complete it and make it more appealing.
  • Make sure beginners are taught well during their journey to the Web: MDN is not the only resource out there to learn the Web. Beyond our own contents, it's part of the Mozilla mission to help discover and found useful good resources to learn about the web.

Success metrics

In order to get some rational measurement about the success of our actions, the following metrics are suggested:

  • Measure the increase number of unique visitors on beginner contents:
    That would be a good sign that our beginner contents is easier to reach. For 2015, we expect to get 580 000 unique visitors to our Learn zone and Glossary by the end of the year.
  • Measure the increase number of returning visitors on beginner contents:
    That would be a good sign that the beginners content is appealing for them.
  • Measure the increase of time per page on the beginners content:
    That would be a sign that more beginners read and learn from that content.
  • Measure the decrease of bounce rate on the beginners content:
    That would be a sign that more beginners read and learn more from content on MDN
  • Measure bounce to third party resources we selected:
    That would be the sign that more users trust MDN as a reliable source of information regarding third party content.
  • Measure the increase of incoming links to MDN beginner contents:
    That would be the sign that MDN is considered as a trustable resource for beginners.

In addition, we should try to gather direct feedback on the improvements which are to be made.

Current available metrics are available on WikiMo.

Note: This project is action-driven, not time-driven. This means that we will do what needs to be done to create this content, regardless of how long it takes. However, to avoid being bogged down in this project forever, it is broken down into small, actionable steps which let us measure progress frequently.

Project status

Weekly meeting

We hold a weekly project meeting, which everyone's welcome to attend. The meeting is held in the #mdn IRC channel every Monday at 10:00 AM PDT (18:00 UTC, 19:00 CET).

Agenda and notes: WikiMo

Work in progress

See the trello board and the doc  status pages:

2014 Archives

Status reports

References

Existing third party content

These web sites are potential sources of inspiration when creating content for new Web developers.

Help the 'Learn' documentation project…
Topic driver : Jeremie Patonnier (IRC nickname: Jeremie)
Look at the current status of the 'Learn' documentation.
Don't hesitate to contact us on #mdn or on the dev-mdc mailing-list:

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, jswisher, Jeremie, fscholz, SphinxKnight, klez, kklein
 Last updated by: chrisdavidmills,