Table of contents:
- What do I need?
- Reviewing the screenshots
- Updating existing screenshots
- Creating new screenshots
- Screenshots versus videos (GIFs)
What do I need?
- Fresh WordPress install, the default theme and no additional plugins – WordPress Playground, InstaWP
- Screenshot tool with annotation abilities – Awesome Screen recorder and screenshot (Microsoft app, Mac App Store, Chrome extention), Nimbus screenshot (has extensions for all major browsers)
Reviewing the screenshots
When the new WordPress version is released, we want to make sure all the screenshots in the documentation match what’s in the latest WordPress dashboard. Compare screenshots in the documentation article to the dashboard in the fresh WordPress install with the latest version.
Any user-facing change means we need a new screenshot:
- things are added – new buttons, text, controls, settings, etc.
- things are removed – things visible in screenshots no longer exist in the dashboard.
- things are moved – things visible in screenshots no longer exist in that place.
- things look differently – things in screenshots are in the same place in the dashboard, but they look differently (e.g., the editor background is changed due to a different default theme; icons in the toolbar are changed, etc.)
Updating existing screenshots
When creating a new screenshot, it’s important to cover the same area as the existing screenshot or, if things have moved to a different place, cover the same interface.
Some screenshots are annotated. It is preferred to use the same annotation for new screenshots as well.
All screenshots should be uploaded in the comment section of the appropriate 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, after which someone will review them and update the article. Here are some examples of completed issues for updating screenshots.
Creating new screenshots
Sometimes, a feature is new, and there is no existing screenshot. Depending on the feature, showcasing it might need more than one screenshot.
When creating a new screenshot, ensure you capture enough of the surroundings to make it easier for end-users to locate it. Use annotations if necessary. Follow the order of actions in order to use the feature successfully.
All screenshots should be uploaded in the comment section of the appropriate GitHub issue, after which someone will review them and update the article.
Screenshots versus videos (GIFs)
If the feature is complex and requires a significant number of screenshots, consider recording a video demoing its usage. This video can be converted to GIF and accompanied by one or two screenshots if necessary.
Upload the video (GIF) in the comment section of the appropriate GitHub issue, after which someone will review it and update the article.
