Web Workers documentation plan

by 1 contributor:

Web Workers provide a way for JavaScript code to run multiple tasks at once, by creating worker objects which run in a separate process on the CPU. There are multiple kinds of Worker designed for different tasks, and we only document some of them. In addition, much of our existing material is dated, and sample code no longer works. We need to update the existing content and add new material as well.

Name: Web Workers (#)
Description:
Owner: Ben Turner
Peer(s): Blake Kaplan, Jonas Sicking, Kyle Huey
Source Dir(s): dom/workers/
Bugzilla Component(s): Core::DOM: Workers
URL: https://developer.mozilla.org/En/Using_web_workers
Discussion Group: dev-platform

Team

chrisdavidmills
Primary writer.
sheppy
Assisting as needed.

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

  • Complete references for all Worker interfaces, including all interfaces (and their properties and methods).
    • Update all existing worker documents, including:
      • ...
    • Write interface landing pages and reference pages for all undocumented worker interfaces and their properties and methods.
  • Thorough guide to each type of Worker, covering:
    • Use cases
    • Functional differences
    • Proper usage
  • Guide to choosing the right type of worker for your needs
  • Solid examples that provide adequate coverage for all Worker classes
  • Update all API documentation to indicate whether or not they can be used from workers
    • This means figuring out a standard, easy to spot and understand, method for providing this information.
    • Could we use a badge that appears somewhere near the top of the page?
    • Or does it just go in the info block at the top of the page?
  • Similarly, find places elsewhere on MDN where proposing the use of a worker makes sense and link to appropriate docs.
  • We have a few scattered half-baked tutorials and guides for workers that need to be updated, merged, and/or replaced, including

Target milestones

We need to device a series of appropriate milestones, then file bugs for each. These should block bug 1050927, which is this project's tracking bug.

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

User stories

Documents needed

The lists here detail specific types of content that need to be produced, as well as precise pages that we know need to be produced or updated.

Types of pages

The following types of pages will need to be produced.

  • Reference
    • Interfaces
    • Properties
    • Methods
    • Events
  • Landing pages
  • Guides/tutorials
  • Sample apps and web content

Reference page work needed

  •  

User guide work needed

  •  

References

Existing content

Other notes

None at this time.

Document Tags and Contributors

Contributors to this page: Sheppy
Last updated by: Sheppy,
Hide Sidebar