We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

This page tries to track ongoing documentation work for MDN QA docs. Feel free to contribute!

Summary

Pages No tags Needs* tags Missing tags Editorial reviews Technical reviews Outdated pages Dev-doc-needed bugs Documentation requests Missing pages
108 27 (25%) 4 (4%) 0 (0%) 0 (0%) 4 (4%) 94 (88%) 0 (0%) 95 (88%) 26 (25%)

See also localization status of this section.

No tags

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

Needs* tags

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

Technical reviews

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

Outdated pages

Found 94 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 95 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
783855 Migrated image/attachment all need a REDIRECT to be fetched
855636 Show footer with all versions on "Firefox <XX> for developers"-pages
908424 DeviceStorage documentation errors
950811 The 'Event Guide' needs a high level organization
952807 Too many tags linked to no articles
960944 Remove or relicense pages from 'Creating XPCOM components'
1081114 Document best practices for login forms
1119251 Accessibility: External links
1188838 Add JSON template for DOM events
1189700 Better beginner's documentation for CORS
1195781 Document 'distributed node' in the Glossary
1202694 Change cookie library on https://developer.mozilla.org/en-US/docs/Web/API/document/cookie
1208816 Document XPathResult
1212760 Use .properties for the event summary tables
1224966 Code on developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/deriveKey will not run, has many bugs
1231694 Complete documentation for RTCIceCandidate
1231772 embedLiveSamples that need attention
1245319 404 Videotrack.sourceBuffer and Texttrack.sourceBuffer
1250768 Document NonElementParentNode DOM mixin
1254181 Document RTCOfferOptions
1259002 Navigation side bar on mdn does not exist in zh-CN but exists in en-US
1270376 `server-sent events` page not in Web APIs list.
1287617 Don't link to obsolete specs
1289971 HTMLCommandElement document link is not existed
1296830 The documentation for XHR overrideMimeType shows info for Request instead.
1298689 English versions of Firefox Addon creation sites are much too complicated to understand (maybe even for native speakers), so nobody can really translate them
1298724 Bug in StringView code
1301998 Specifying security concerns for targetOrigin of postMessage
1303641 Documentation links broken - characterdata
1308164 Bug reporting link does not work
1314652 Create a tool for cross-version Firefox code search and compare
1315191 searchParams is available at least from Firefox 49
1316924 Broken link for "Example WebExtensions" pointing at https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Example_WebExtensions
1318850 missing page link in Client-side_web_APIs/Introduction
1320955 Advanced Network Communication Section Not Found.
1322820 Bit masks in WebGL documentation
1322823 Template:KeyboardEventProperties seems outdated and incorrect
1328799 revise <dialog> page: Specifications table
1332938 list of dependency versions linked to in release documentation would be nice
1333751 Intent to delete: Connect pages
1335579 Broken link 'composedPath()' in documentation (or missing documentation).
1337332 Fully document the History API
1339914 Error: WebGL: texImage2D: Conversion requires pixel reformattin
1340062 I translte https://developer.mozilla.org/en-US/Add-ons/AMO/Policy/Agreement and translte “Agreement ” to “协议”
1342055 mising example prototype
1342609 Documentation Q: Description section, paragraph 2 might want to mention Maps
1343145 Clarify attribute checked for <input type="checkbox">
1344254 Create a series of articles introducing media on the Web
1345026 Incorrect/not full information on the location of Eyedropper button
1347159 Window.restore() doc says not working, but works for me?
1349550 It is really true that 405 can't be used for GET or HEAD?
1351137 all DataView methods need parameter documentation
1352109 404 when accessing the https://developer.mozilla.org/en-US/docs/Web/API/SVGFEConvolveMatrixElement
1353757 A confusing explanation of a code snippet
1358768 ARIA techniques article split up or combination
1358933 Image in article provides pointer labels in French
1360820 A code example missing
1364757 HttpOnly documentation explanation ambiguity
1366867 Mobile cross-browser subset of HTML/CSS
1367037 `thing` does not exist
1368043 Correcting Browser Console in Portuguese Language
1370109 Reference trail from the note re Safari on the :hover article
1372074 Strict rules for JavaScript snippets.
1372493 Outdated link to CSS Backgrounds and Borders Module Level 3
1372609 Intersection Observer page auto-scrolls to embedded iframe on load
1382160 Typo in image about caching
1386720 "For sideloading" & "For desktop apps" & "For an enterprise" links under "Distributing add-ons" are broken
1387131 "Web technology reference" page is incomplete
1389025 Editorial review for typos and grammar on Web_Crypto_API
1389431 current content needs to be reseted back to english version
1391059 some CORS examples are inaccurate
1394177 Number Guessing Game
1394870 Object.entries change
1399054 Documentation needs KeyboardEvent.key footnote regarding support on Android (KeyboardEvent.key support is broken)
1400210 Mistake in the Introduction of "Memory Management" chapter
1404580 Document connect event
1405347 Fully document SVGMatrix and DOMMatrix
1405398 Add `SSL` to MDN Glossary
1406013 Broken link/missing page for FileReader/FileReader constructor
1407191 Event loop message queue processing: incorrect description
1407340 Write glossary entry for "Cache"
1409246 Service Worker introduction talks a lot about AppCache.
1409952 Fully document 'FontFace'
1410019 Suggested implicit call of 'Date.parse' method is incorrect
1410675 Docs say `delete` on a non-configurable property raises a SyntaxError in strict mode.
1410743 Open page "https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/Channels" shows "You're trying to create a new page."
1413456 Concept of "Hoisting"
1415806 the list of keyboard shortcuts is incomplete
1416300 Event documentation is missing from iframe
1416304 Not explained what asterisks mean
1416896 Wrong translation: "prefer_related_applications": falsch
1417143 "ellipsis" and first+second value "percentage"
1418428 some function are no longer supported
1418612 note about "pagination" / ordering could be better placed elsewhere
1418754 Correct link on Static Analysis page

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 108 0 (0%) 0 (0%)
bn-BD 108 3 (2%) 1 (33%)
de 108 2 (1%) 0 (0%)
es 108 6 (5%) 1 (16%)
fa 108 0 (0%) 0 (0%)
it 108 0 (0%) 0 (0%)
ja 108 14 (12%) 2 (14%)
ko 108 2 (1%) 0 (0%)
pl 108 1 (0%) 0 (0%)
pt-BR 108 5 (4%) 1 (20%)
pt-PT 108 1 (0%) 0 (0%)
ro 108 0 (0%) 0 (0%)
ru 108 6 (5%) 2 (33%)
zh-CN 108 4 (3%) 1 (25%)
zh-TW 108 0 (0%) 0 (0%)

General plan for QA docs

Mozilla has lots of QA documentation available: QMO, Main MDN QA landing page, Firefox OS automated testing landing page, and more. We ought to streamline our QA content by weeding out the obsolete stuff, updating the out of date stuff, and turning the different resources into a more cohesive resource.

Team

  • Chris Mills: MDN editor
  • Marcia Knous: Main QA contact

Join the project

MDN is built by you, the reader! If you'd like to help make this documentation real, we'd like to hear from you. You may contact the writing team by clicking on their names above, or on our mailing list. If you're a new MDN contributor, please have a look at our contributor guide. You can also join the conversation in our IRC channel #mdn.

Goals

Audit our current QA content

  • Write a plan for reorganizing it into a more cohesive resource that lives on MDN.
  • Migrate the non MDN content over to MDN.
  • Update and reorganize the existing material on MDN.
  • Make it easier for QA staff and volunteers to help perform QA work.

Target milestones

TBD: This work is not super urgent, but it would be nice to do it soon.

Note: Each milestone bug should block bug 1054344, which is a tracking/meta bug for this project.

User stories

  • I want to write tests for Mozilla products
  • I want to Help perform QA/testing work on Mozilla products
  • I want to find out what tools I need to use to do QA work, what workflow I'd use, and how to get started.
  • If I want to help with testing of Firefox, Firefox OS, or other Mozilla projects, where do I find out what needs to be tested?

Documents needed

Mainly reference and guide documents. This is mainly TBD. This can be done after the audit of existing docs.

Existing documents

Notes

The following items were discussed in a meeting between Chris Mills and the QA staff.

What should be kept where, on MDN?

Should we keep everything under a top level QA node, or should that node just contain generic stuff like introduction, how QA works at Moz, what all the tools are, how to get involved in the community, call to action, etc.? We could then put more applied Firefox / Firefox OS - specific stuff in the relevant zones and link to those from the main QA node. I think this latter idea is better for organization, as people are more like to think product first, then QA, rather than QA first, then product, although both camps do probably exist. This would allow us to cover both.

What should be moved over from QMO?

This is up for discussion. The content (on both MDN and QMO) needs to be audited to work out what stuff should be kept, and what stuff can be dumped due to being out of date or dupe.

There was also the question of whether the community / call to action stuff should remain on QMO, but the actual content should go on MDN, as QMO already has a bit of a following/page rank

I (Chris) personally think everything should just go on MDN, as MDN's page ranking will be higher, and it's good to have everything in one place and not fragmented. Plus if it is on MDN, it is all under the remit of the MDN editors, so we can maintain it.

Tips and tricks (for example B2G tips and tricks and QA tips and tricks) should go somewhere sensible as well.

Should QA be a zone?

I think so. I think QA falls under the zone definition, in that it is a specific function, product or action.

Next steps

  1. QA team to audit existing material.
  2. Chris Mills to work out where to put all the material, and draw up plan for content strategy

See also

This QMO Etherpad for further discussion/raw notes.

Document Tags and Contributors

Contributors to this page: fscholz, jswisher, chrisdavidmills
Last updated by: fscholz,