Step 4: Review existing content
This is Step 4 of the Editor’s Guide.
Step 4. Review existing content
All of Web Platform Docs are in review at all times! Okay, seriously though, this means you should always have your editor’s hat on when reading through these pages. When you see something that needs fixing, yup, fix it!
If you’re not sure whether to fix something or how, you can at least set a flag for the issue you find with the content. This page describes the various flags you can apply.
For lists of pages that have been identified as needing review (with the flag, “Needs Review”), see Review content in the Getting Started guide.
Flag issues to identify pages with broken links, spelling, product bias, and other problems
- Click the Edit button in the top right corner of the article and choose Edit to access the check boxes used to flag issues.
Mark articles that need revisions by checking the corresponding check boxes
In this wiki, we use flags to mark articles that require fixes or additional work. By flagging pages, you are helping the community track issues. Flags are set up to automatically create lists of tasks to accomplish.
Flags are used in conjunction with comments to provide more details about the content to fix on a page. Flags are used to mark issues for an entire page; they enable editors to locate pages that require specific kinds of work. Comments are used to describe issues with a specific section of the page; they help editors quickly find the areas within a page to change.
How to add a flag
When you see an issue with a page, to add a flag, go to the page to be flagged and click on the Edit button to see the editing interface. This is essentially a form with check boxes and fields, including the text field that contains the page content.
In the sections of the form labelled High-level issues or Content, click the check box next to the appropriate flag. For example, if you think that the page contains information that is duplicated on another page, select the Merge Candidate checkbox.
If a warning appears stating that you need to include more information about the flag, enter the details about the issue in the Block of editorial notes field.
For example, if you enabled the Merge Candidate check box and you are suggesting that the current page should be merged with /docs/css/atrules, then your block should look like this:
List of work item flags
Flagged articles are automatically marked as work items, so that contributors can resolve issues and ensure the page meets the WebPlatform’s quality standards. One of the primary goals of contributors is to fix the issues that the flags specify, and to eventually have no remaining work item flags to address.
Different flags use different guidelines that dictate when they should be applied and if editorial notes are required. Always read the notes about a flag before enabling it.
Here is the full list of high and low priority flags used in the wiki:
Content quality (high priority issues)
- Deletion Candidate
- Merge Candidate
- Split Candidate
- Copyright Issue
- Undescriptive Title
- Needs Flags
- Needs Topics
- Missing Relevant Sections
- Data Not Semantic
- Unreviewed Import
Content quality (low priority issues)
- Content Outdated
- Content Incomplete
- Content Errors
- Content Not Neutral
- Content Grammar Spelling
- Content Cleanup
- Content Broken Links
- Compatibility Incomplete
- Content Accessibility
- Examples Needed
- Examples Errors
- Examples Best Practices
Notify other editors about pages that require revisions
- Communicate with the WebPlatform.org online community to ask for clarification and help resolving issues. You can raise issues on IRC, send messages to the the email@example.com mailing list, or post messages in the forum.
See Step 2 of the Editor’s Guide for more details.
Check the topics and topic clusters
While you’re reviewing the content, take a sharp look at the topics and topic cluster tags assigned. In many cases these may not be applied properly, and it’s difficult to tell if there is a problem. See Topics and topic clusters for guidance.