mozilla
Your Search Results

    Reviewing articles

    When writers add or make changes to articles, they have the option of marking the article as being in need of review. That is, they can indicate that someone should look over the article to ensure its quality.

    Your mission (if you choose to accept it) is to read over the article and review its contents. Obviously, you should only technically review articles whose technology you understand well, and similarly, you should only perform an editorial review if you're reasonably good at the language in which the article is written.

    This article provides an introductory guide to the process of reviewing articles, as well as to the types of review you can help with.

    Types of review

    There are three kinds of review:

    Technical review
    A technical review is where someone with strong knowledge on the topic covered by the article reads the article and ensures that it is technically and factually accurate. They either take notes and send them along to the writer(s) or make corrections in-page themselves (the latter being the preferable approach).
    Editorial review
    An editorial review is one in which the reviewer reads the article and corrects typos, grammatical mistakes, and formatting or layout problems. This also involves ensuring that the article matches the MDN style guide.
    Template review
    MDN uses macros (sometimes called "templates") to automate generation of content. These are server-executed JavaScript programs that use some additions that, together, we call KumaScript. Users with advanced macro editing permissions can use template reviews to ask one another to double-check their work.

    Articles in need of review have one or both of these banners across the top of the page:

    Screen shot: Review banners

    Finding articles to review

    While you can certainly stumble upon articles for which reviews are needed while browsing MDN, there's also a way to get an actual list of flagged articles:

    Quick review

    If you read over the article and there aren't any problems, you don't have to open the article editor to mark the article as "reviewed." Instead, you can use the "quick review" box at the bottom of the page. It looks something like this:

    Screen shot: Quick review box

    Simply toggle on the checkbox(es) for the reviews you've performed and click "Confirm reviews". If you're not logged into MDN, you'll be prompted to log in. Then this will update the article's review flags appropriately.

    In-editor review

    On the other hand, perhaps you've reviewed the article but had to make some changes, so you're in the editor. You can mark off the article as having been reviewed here, too.:

    Screen shot: In-editor review box

    In this case, you need to toggle off the checkboxes for the reviews you've performed, then save the article.

    Document Tags and Contributors

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