search

gbif / doc-documentation-guidelines

Guidelines for authoring digital documentation for GBIF
https://docs.gbif.org/documentation-guidelines/en/
Other
0 stars 1 forks source link

Guidelines for screenshots #11

Open MattBlissett opened 5 years ago

MattBlissett commented 5 years ago

It will be useful to give guidelines for taking good screenshots.

For web browser screenshots

  1. Use a browser extension like Window Resizer (not necessarily the best, just the first result) to keep a consistent size.
  2. Either use the build-in developer tools (F12 on Linux or Windows) and the 📷 button, or a screenshot browser extension to take the screenshot. Or Firefox has a new built-in screenshot thing: https://screenshots.firefox.com/, it looks like this makes it very easy to screenshot a single element of a page (e.g. a dialog) so there's no need to crop afterwards.

For other screenshots

  1. Use the correct shortcut to take the screenshot. Especially on Windows and Linux, there are shortcuts to screenshot only a single window, which saves cropping: https://www.take-a-screenshot.org/windows.html
  2. There are also tools to resize windows to specific sizes

Both

  1. Investigate whether it's better for screenshots to be taken at 2× resolution, so they don't look fuzzy when shown on HiDPI screens.
  2. Investigate how the screenshots are scaled in the created document

Automation

  1. It would be possible to automate the screenshots, for example to re-run all the screenshots with the tool set to a different language, but setting up and maintaining this is probably more work than is reasonable.