Goal:
Find a documentation page that has been flagged as needing attention. Review, proofread, or edit the page.
Skills required:
Detailed steps:
- Set up prerequisites: Log in from Common Prerequisites for Contributors.
- Visit the Documentation Management page.
- Filter the list to show pages that needs attention:
- Content type: Documentation page
- Page status: Needs review or Needs work
- Look through the list for a page that interests you. Click the title to visit the page.
- In the green operations drop-down that shows the Edit link, click Discuss.
Read the most recent comments to see if there is any information about why the page needs work or needs review. - Click the page title in the header breadcrumb area to return to viewing the page
- Review the page, to see if it needs editing. Things to look for:
- Proofreading (spelling, grammar, punctuation)
- Does the content follow the content style guide and the documentation structure guide?
- Is the content accurate?
- If the page describes a task, and you follow its steps, do they work?
- If the page needs editing:
- Click Edit.
- Make the needed changes to the Body and Title.
- Verify that the Summary summarizes the page content. (The summary appears on the parent Guide page, but not on the page itself.)
- Update the Page status to No known problems (or another status if that is more appropriate).
- In Explain your changes, describe the edits you made and why you chose this page status.
- Save your changes.
- If the page does not need editing:
- Click Discuss in the operations dropdown to return to the Discuss page.
- Change the Page status to No known problems.
- Write a comment in Suggest improvements explaining how you reviewed the page and/or why you think there are no problems.
- Save your comment.
