Guidelines for reviewing content

Please remember to review content constructively and kindly. The emphasis is not on perfection but rather on community, contribution and iteration. 

Suggestions for how to review tutorials and provide actionable feedback

  • Are the learning outcomes or achievement objectives clear?
  • Check for technical accuracy, i.e. has the person described or misdescribed something or used any technical terms incorrectly. Suggest ways of explaining things better or more clearly.
  • Is the speed of demonstrations appropriate to follow along and understand?
  • Does the narration match the slides and demonstration?
  • Are grammar and spelling correct? (Note, the Training Team uses American English for its English resources. See Language and Spelling for more information about this.)
  • Is sound quality consistent throughout the video?

Suggestions for how to review courses and provide actionable feedback

  • Are the learning outcomes or achievement objectives clear?
  • Check for technical accuracy, i.e. has the person described or misdescribed something or used any technical terms incorrectly? Suggest ways of explaining things better or more clearly.
  • Are the steps clear and accessible for anyone to follow, including ESL and neurodivergent readers? 
  • Does the layering of information successfully build from lesson to lesson?
  • Is it easy to skim-read the content?
  • Are grammar and spelling correct? (Note, the Training Team uses American English for its English resources. See Language and Spelling for more information about this.)
  • Could we improve the activities and assessments in the course?
  • Do lessons contain enough relevant links to documentation (WordPress documentation or any other relevant documentation)?
  • Do all the links work?

Are you reviewing content before it is published?

If so, then please leave your review comments on the GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ issue for that piece of content. This helps the Training Team track your contributions. It also helps others see what comments have already been made so that their efforts don’t double up with what has already been done.

Also, if there are parts of the tutorial or course you particularly liked, feel free to leave comments about those on the GitHub issue also! Content creators will appreciate any positive feedback you can give, too, and will consider implementing those in future content also.

Top ↑

Are you reviewing content after it is published?

If so, then please leave your review as a new Content Error Report on GitHub. This tracks your contribution to the team, and also leaves a public note about your report so that anybody can come and make updates as needed. You can submit a new report by following these steps:

  1. Go to the list of issue templates on the Training Team’s GitHub repo
  2. Find Content Error Report Template and click Get Started
  3. Follow the directions you’ll see in the issue template to update the issue title and description

Last updated: