Glossary documentation status

This page tries to track ongoing documentation work in the MDN Glossary. Feel free to contribute! Planning and actual work in progress is tracked on the  the community trello board.

Summary

Pages No tags Needs* tags Missing tags Editorial reviews Technical reviews Outdated pages
353 2 (1%) 12 (4%) 8 (3%) 5 (2%) 42 (12%) 158 (45%)

See also localization status of this section.

No tags

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

Needs* tags

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

Missing tags

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

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

Editorial reviews

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

Technical reviews

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

Outdated pages

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

Localizations

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

Language Pages Translated Translations up to date
bn-BD 208 1 (0%) 0 (0%)
de 353 11 (3%) 8 (72%)
es 353 26 (7%) 5 (19%)
fa 353 0 (0%) 0 (NaN%)
fr 353 305 (86%) 230 (75%)
ja 353 0 (0%) 0 (NaN%)
ko 353 14 (3%) 10 (71%)
pl 353 6 (1%) 1 (16%)
pt-BR 353 37 (10%) 26 (70%)
ru 345 22 (6%) 9 (40%)
zh-CN 353 22 (6%) 17 (77%)
zh-TW 290 5 (1%) 1 (20%)

Current priorities

Technical Review

There are a lot of articles flagged for technical review. You can check if they are technically correct and correct them and/or remove the flag as appropriate.

Editorial Review

Articles need to be correctly formatted and spell-checked. Here is an example of a well-formatted entry.

Cut longer articles

If an article is too long, it needs to be reduced as per guidelines here. If you think a long article is particularly well written and deserves to be preserved, discuss it with us, on the dev-mdc mailing list. It can be moved to the appropriate area of MDN if it's deserving of it's own place on the site.

General check of completeness

There are a lot of articles. We should check to see if they need content and tag them appropriately. Coordination for this work is done on our Trello board.

Use the Glossary macro

Articles in the Glossary Area, the Learning Area and MDN in general should use the Glossary macro (where appropriate). You can learn more about the glossary macro here.

How to improve the content

Tagging standard

  • Each page should be tagged with at least one tag from the web literacy map.
  • If pages are related to a given technology, they should be tagged with that technology name.
  • If pages need any type of work, a "Need*" tag should be added.

While browsing and editing MDN, you can easly link any term to the glossary by using the Glossary macro.

It takes up to three possible parameters:

  1. The term to link to (note that terms are case insensitive)
  2. An alternate text to display (an expression identical to the term, a plural version, etc.)
  3. A flag indicating if the link must be displayed as a regular link (1) or as a soft link (0, the default)
Macro Result
{{Glossary("Browser")}} Browser
{{Glossary("Browser", "Web browser")}} Web browser
{{Glossary("Browser", "Web browser", 1)}} Web browser

Writing a term definition

A term definition page must have three clear sections:

  1. A summary that shortly defines the term (one to two sentences at most)
  2. An in-depth definition that provides all the necessary details to understand what the term covers
  3. A "Learn more" section that provides various links to dig deeper in the area covered by this term

The content of a term definition must be written assuming the reader has no specific knowledge about the term and its usage. Use simple and straightforward English. Try to avoid as many technicalities as possible (it's not always possible but try to simplify).

Please remember that while gathering information from other sites is a good thing, it isn't good practice to copy and paste passages (or even entire articles) from them (otherwise we could just link to them).

For more detailed information check out the "how to write a new entry in the glossary" article.

Learning area meeting

The Learning Area weekly meeting takes place in the #mdn channel on irc.mozilla.org at 10 AM PDT (17:00 UTC, 19:00 CET). See the meeting time in your time zone. It's open to anyone that would like to participate, so please feel free to join in!

Join the Glossary community

Choose your preferred method for joining the discussion:

Document Tags and Contributors

 Contributors to this page: Jeremie, jswisher, hbloomer, chinaowl, SOBrien, fscholz, klez, Sheppy
 Last updated by: Jeremie,