blob: 230b3657a0fd388a8ed1af10aa35c0198a5e1b3f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
---
title: How to do a technical review
slug: MDN/Contribute/Howto/Do_a_technical_review
translation_of: MDN/Contribute/Howto/Do_a_technical_review
---
<div>{{MDNSidebar}}</div><p class="summary"><strong>Technical review</strong> consists of reviewing the technical accuracy and completeness of an article, and correcting it if necessary. If a writer of an article wants someone else to check the technical content of an article, the writer ticks the "Technical review" checkbox while editing. Often the writer contacts a specific engineer to perform the technical review, but anyone with technical expertise in the topic can do one.</p>
<p><span class="seoSummary">This article describes how to go about perfoming a technical review, thereby helping to ensure that MDN's content is accurate.</span></p>
<table class="fullwidth-table">
<tbody>
<tr>
<td><strong>Where does it need to be done?</strong></td>
<td>In specific articles that are marked as requiring a <a href="/en-US/docs/needs-review/technical">technical review</a>.</td>
</tr>
<tr>
<td><strong>What do you need to know to do the task?</strong></td>
<td>
<ul>
<li>Expert knowledge of the topic of the article you are reviewing.</li>
<li>Ability to edit a wiki article on MDN.</li>
</ul>
</td>
</tr>
<tr>
<td><strong>What are the steps to do it?</strong></td>
<td>
<ol>
<li>Go to the list of pages that need <a href="/en-US/docs/needs-review/technical">technical reviews</a>. This lists all the pages for which an technical review has been requested.</li>
<li>Choose a page whose topic you are very familiar with.</li>
<li>Click on the article link to load the page.</li>
<li>Once the page has loaded, click the <strong>EDIT</strong> button near its top; this puts you into the MDN editor. Don't hesitate to switch to a different page if the first one you choose doesn't suit you.</li>
<li>While reading the article, fix any technical information is not correct, and add any important information that is missing.</li>
<li>Enter a comment at the bottom of the article that describes what you did, like '<em>Technical review completed.</em>' If you corrected information, include that in your comment, for example <em>'Technical review: fixed parameter descriptions.'</em></li>
<li>Click the <strong>SAVE CHANGES</strong> button .</li>
<li>Once the corrected article appears on-screen after the editor has closed, check the <strong>Technical</strong> entry on the side (under <strong>The following reviews have been requested</strong>) and click <strong>SUBMIT REVIEW</strong>.</li>
<li>You're done!</li>
</ol>
</td>
</tr>
</tbody>
</table>
<p> </p>
|
