You’re reading the English version of this content since no translation exists yet for this locale. Help us translate this article!
Editorial reviews consist of fixing typos, spelling, grammar, usage, or textual errors in an article. One does not have to be a writing expert to make valuable contributions to MDN's technical documentation, but articles still need copy-editing and proof-reading. This is done in an editorial review.
This article describes how to do an editorial review, which helps ensure that MDN's content is accurate and well-written.
- What is the task?
- Copy-editing and proof-reading of articles that are marked as requiring an editorial review.
- Where does it need to be done?
- Within specific articles that are marked as requiring an editorial review.
- What do you need to know to do the task?
- You need to have good English grammar and spelling skills. An editorial review is about ensuring that the grammar, spelling, and wording are correct and make sense, and that the MDN writing style guide is followed.
- What are the steps to do it?
- Pick an article to review:
- Go to the list of articles needing editorial review. This lists all the pages for which an editorial review has been requested.
- Click on the article link to load the page.
Note: This listing is generated automatically but infrequently, so some articles appear on the list that no longer need editorial review. If the article you picked does not display a banner that says "This article needs an editorial review", skip that article and pick a different one.
- Read the article carefully, looking out for typos, spelling, grammar, or usage errors. Don't hesitate to switch to a different page if the first one you choose doesn't suit you.
- If there are no errors, you don't need to edit the article to mark it as reviewed. Look for the "quick review" box in the left sidebar of the page:
- Deselect the Editorial box and click Save.
- If you find errors that need to be corrected:
- Click the Edit button near the top of the page; this brings you into the MDN editor.
- Correct any typos and spelling, grammar, or usage errors you find. You don't have to fix everything to be useful, but be sure to leave the editorial review request in place if you don't feel reasonably sure that you've done a complete review of the entire article.
- Enter a Revision Comment at the bottom of the article; something like 'Editorial review: fixed typos, grammar & spelling.' This lets other contributors and site editors know what you changed and why.
- Deselect the Editorial box under Review Needed?. This is located just below the Revision Comment section of the page.
- Click the Publish button.
Your changes may not be visible immediately after saving; there may be a delay while the page is processed and saved.
- Pick an article to review: