Screenshots

Last Updated on June 23, 2024 by Neil Murray

Table of Contents #

Why Screenshots #

Screenshots are a great way to record your work. We use screenshots to allow other team members to understand & review the work you have done including changes and progress..

Team members are required to document each & every task with screenshots stored in the respective Task folder.

NOTE: These are screenshots each team member deliberately takes & adds to relevant Sync folders. This is not the screenshots that Hubstaff takes automatically whenever you are logged in.

Good screenshots can be self-explanatory and convey information concisely and quickly.

back to top

Screenshot Tools #

For Windows, use the Snipping tool and Screenshot for macOS.

It is also recommended to highlight or point out important elements with the help of text, arrows and boxes. You can use simple programs like MS Paint or Paintbrush to edit images.

Screenshot with highlights

I use TechSmith Capture for taking screenshots on Windows & Awesome Screenshot (Chrome Extension) to add markup to screenshots.

Neil Murray

Some elements like long forms or large code snippets cover multiple pages i.e. need scrolling in your browser for a complete view.

[ADD large image]

In this case, you can use Save full page option in Firefox, or Capture full page in Edge browser. Chrome requires extensions like Fireshot and Awesome Screenshot for this purpose.

If you are adept at or prefer another tool/software, you may use that, provided you stick to our style and format of screenshots.

back to top

Screenshot Naming #

We use a consistent naming format for all screenshots. This makes it easier for others to understand your work.

General Screenshot Naming #

Each screenshot name should clearly identify:

  • Index or Serial number (optional)
  • Image number
  • Short description of the screenshot
  • Date the screenshot is taken

When an Index or Serial number is used:

  • Index or serial-number_description_year-month-day or
  • Index or serial-number)_year-month-day_description

Some examples:

  • 01_set file size limit for file_2024-05-03.png
  • 13_Clicking on Backend Editor on draft pricing page_2023-08-30.png
  • 02_2023-08-30_Stats setting Inactive.png

The description must explain clearly what you actually did in each screenshot.

When an Index or Serial number is not used:

year-month-day_image-number_description

Some examples:

  • 2023-08-30_13_Clicking on Backend Editor on draft pricing page.png
  • 2023-08-30_02_Stats setting Inactive.png
  • 2024-05-12_01a_recent_gig_poster_using_queryloop.png

[ADD examples of good & bad screenshot naming]

General Screenshot Indexing #

Indexing screenshot names forces the screenshots to be sorted in a logical order. The aim is to make understanding & reviewing the work done much easier for others.

[ADD examples of screenshot indexing]

See Record Your Work – Screenshots & Text Files.

back to top

Testing Screenshot Naming #

As testing screenshots are generally taken again & again at different plugin versions, this requires some specific naming requirements.

back to top

Screenshot Folders #

back to top

Save Images to Sync #

General Screenshots #

Add the images to as you work – don’t do it as a separate exercise after you’ve done the task. This allows others to review your work according to your progress.

[ADD examples]

Testing Screenshots #

See Testing Screenshot Sync Folders.

back to top

Further Reading:

Notes

Save all Images to Sync – use ..\Sync\..\Testing\Testing Guidelines\Screenshots\

  • [ ] Markup Screenshots with Awesome Screenshots

Amend to cover general screenshots used by CF7 Skins Design team as well as CF7 Skins Test. DONE