Documentation bugs

Types of doc bugs

One of the main ways that that the MDN writing team gets requests for new documentation or documentation changes is through Bugzilla. This article describes how to use bugs to note when documentation updates are needed. Within Bugzilla, doc requests occur in two ways:

dev-doc-needed
When a Mozilla product bug results in new features, or modifies existing ones, that affect documentation on MDN, the development team adds the keyword "dev-doc-needed" to the bug. This sends a notification to the MDN team. (MDN team members often abbreviate "dev-doc-needed" to "DDN".)
Documentation requests
When someone notices that a document on MDN is incorrect or incomplete, they can file a bug on Bugzilla to request that it be fixed.

How to help

If you're interested in working on DDN or doc request bugs:

  1. Look for a bug that you might want to help with.
  2. Contact the person who the bug is assigned to; that person can help you figure out what you need to do to make the appropriate changes on MDN, and what would be considered "done" for that bug.
  3. If the current owner agrees, assign the bug to yourself. (If you realize you're unable to finish work on a bug, add an explanatory comment, and un-assign yourself.)
  4. When you are finished:
    • For a DDN bug, change the dev-doc-needed keyword to dev-doc-complete.
    • For a doc request bug, ask for a review of your work. (The original owner is a good person to ask.) If the reviewer approves what you've done, close the bug.

Document Tags and Contributors

Contributors to this page: jswisher, wbamberg, Sheppy
Last updated by: jswisher,