You’ll review proposed documentation fixes for accuracy, style, and accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility), then leave feedback on the issue. This takes the heavy lifting off team members and helps publish fixes faster.
- Reference: Documentation Team Handbook — standards for grammar, style, tone, linking, and screenshots
- Connect: Join #docs on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/ and introduce yourself
Steps
- Set up your testing environment. Open WordPress Playground for testing changes.
-
Pick an issue with the
[Status] Reviewlabel from the Documentation Issue Tracker and comment that you’re reviewing it. -
Understand the problem. Read the issue description, visit the live documentation page, and confirm the reported problem still exists.
-
Review the proposed fix for accuracy, grammar, style, tone, links, screenshots, and accessibility against the standards in the Documentation Team Handbook.
-
Leave a summary comment with what you checked, any problems found, and specific suggestions. Mention a team member (@zzap or @atachibana) when ready for a final check.
Contribution checklist
- Confirmed the reported problem still exists on the live page
- Verified the proposed fix is accurate and solves the problem
- Checked against the Documentation Team Handbook standards
- Posted a summary comment and mentioned a team member for final check
What happens next
A team member will review your feedback and either request changes or apply the fix and close the issue. If there’s no response after 2–3 weeks, pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” in #docs.
When you’re ready, pick up another issue or try filing one.
Help
Stuck? Check the getting help guide, then ask in #docs.
Further reading:
– Documentation Grammar Guide
– Style and Formatting Guide
– Tone and Voice Guide
– External Linking Policy
– Screenshot best practices
– What is WordPress Playground? — learn more about using WordPress Playground