Write: Work on Documentation Issues

Function: Write
Type: Task

Documentation reviewers help the Docs team process issues faster. You’ll check proposed fixes for accuracy, grammar, 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 — taking the heavy lifting off team members and helping publish fixes sooner.

Before you start

Complete the common setup first, then:

• Setup: Set up WordPress Playground for testing changes
• Read: Familiarize yourself with the Documentation Grammar Guide, Style and Formatting Guide, Tone and Voice Guide, External Linking Policy, and screenshot best practices.
• 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

1. Pick an issue with the [Status] Review label from the Documentation Issue Tracker and comment that you’re reviewing it.
2. Read the issue description, visit the live documentation page, and confirm the reported problem still exists.
3. Review the proposed fix for accuracy, grammar, style, tone, links, screenshots, and accessibility against the guides listed above.
4. Leave a comment summarizing 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 documentation style guides (grammar, style, tone, links, screenshots, accessibility)
• [ ] Posted a summary comment on the issue
• [ ] Mentioned a team member for the 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 help review others.

Help

Stuck? Check the getting help guide, then ask in #docs.