Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 1046262 of How to do an editorial review

  • Revision slug: MDN/Contribute/Howto/Do_an_editorial_review
  • Revision title: How to do an editorial review
  • Revision id: 1046262
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment Update for recent UX changes

Revision Content

Editorial reviews consist of fixing typos, spelling, grammar, usage, or textual errors in an article. Not all contributors are language experts, but regardless due to their knowledge will have contributed extremely useful articles, which need copy-editing and proof-reading. This is done in an editorial review.

This article describes how to do an editorial review, thereby helping to ensure that MDN's content is accurate.

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?
  1. Pick an article to review:
    1. Go to the list of articles needing editorial review.  This lists all the pages for which an editorial review has been requested.
    2. Choose a page that has an English title and whose path doesn't start with  Template: (Template: pages contain MDN macro code.)
    3. Click on the article link to load the page.
  2. Read the article, paying close attention 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.
  3. 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:
    Screenshot of the editorial review request sidebar box
    Deselect the Editorial box and click Save.
  4. If you find errors that need to be corrected:
    1. Click the Edit button near the top of the page; this brings you into the MDN editor.
    2. 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.
    3. 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.
    4. Deselect the Editorial box under Review Needed?. This is located just below the Revision Comment section of the page.
    5. 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.

Revision Source

<p class="summary"><strong>Editorial reviews</strong> consist of fixing typos, spelling, grammar, usage, or textual errors in an article. Not all contributors are language experts, but regardless due to their knowledge will have contributed extremely useful articles, which need copy-editing and proof-reading. This is done in an editorial review.</p>

<p><span class="seoSummary">This article describes how to do an editorial review, thereby helping to ensure that MDN's content is accurate.</span></p>

<dl>
 <dt>What is the task?</dt>
 <dd>Copy-editing and proof-reading of articles that are marked as requiring an editorial review.</dd>
 <dt>Where does it need to be done?</dt>
 <dd>Within specific articles that are marked as requiring an editorial review.</dd>
 <dt>What do you need to know to do the task?</dt>
 <dd>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 <a href="/en-US/docs/MDN/Contribute/Guidelines/Writing_style_guide">MDN writing style guide</a> is followed.</dd>
 <dt>What are the steps to do it?</dt>
 <dd>
 <ol>
  <li>Pick an article to review:
   <ol>
    <li>Go to the list of <a href="/en-US/docs/needs-review/editorial">articles needing editorial review</a>.&nbsp; This lists all the pages for which an editorial review has been requested.</li>
    <li>Choose a page that has an English title and whose path doesn't start with&nbsp; <code>Template:</code> (<code>Template:</code> pages contain MDN macro code.)</li>
    <li>Click on the article link to load the page.</li>
   </ol>
  </li>
  <li><a id="core-steps" name="core-steps"></a>Read the article, paying close attention 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.</li>
  <li>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:<br />
   <img alt="Screenshot of the editorial review request sidebar box" src="https://mdn.mozillademos.org/files/13018/SidebarReviewBoxEditorial.png" /><br />
   Deselect the <strong>Editorial</strong> box and click <strong>Save</strong>.</li>
  <li>If you find errors that need to be corrected:
   <ol>
    <li>Click the <strong>Edit</strong> button near the top of the page; this brings you into the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor</a>.</li>
    <li>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.</li>
    <li>Enter a <strong>Revision Comment</strong> at the bottom of the article; something like '<em>Editorial review: fixed typos, grammar &amp; spelling.</em>' This lets other contributors and site editors know what you changed and why.</li>
    <li>Deselect the <strong>Editorial</strong> box under <strong>Review Needed?</strong>. This is located just below the Revision Comment section of the page.</li>
    <li>Click the <strong>Publish</strong> button.</li>
   </ol>
  </li>
 </ol>

 <div class="note">
 <p>Your changes may not be visible immediately after saving; there may be a delay while the page is processed and saved.</p>
 </div>
 </dd>
</dl>
Revert to this revision