Error Documentation Methods

When using software programs or operating systems, it's not uncommon to encounter technical problems that need to be documented for further reference or analysis. In such cases, having a video recording of the error can be incredibly helpful. But, many users are not sure how to take screenshot of an issue. In this article, we'll walk you through the simple guidelines to capture screenshots and record evidence of errors.



Taking a Screenshot



Taking a capture image is a easy process that varies due to the operating system you are using. Here's a diagrammatic guide for Windows individuals:



For Windows:


Press the Print Screen key (usually located adjacent to the Ctrl and Scroll Lock key keys) on your input device.
Open the image editing software (pre-installed on Windows or obtain elsewhere) or any other graphic design tool.
Press Control + V to insert the screenshot into the application.
Save the screenshot with a description that explains the problem.
You can also use the Snip & Sketch tool in Windows 10 and later versions to capture specific regions of the screen or take a image of an open window.

For Mac:

Press Command mega888 + Shift + 3 (to obtain a full-screen capture) or Command + Shift + 4 (to select a specific region of the screen) on your input device.
Release the keys to record the screenshot.
You'll see the image saved on your workstation as a PNG file.
Name the image with a informative file name, and save it in a designated folder.

Recording Evidence


Recording a video recording of the problem provides more context than a static screenshot and can help support teams diagnose the problem more accurately. Here's how to capture a video recording on Mac:



For Windows:


Obtain and install and open screen recording software (free screen recording software).
Choose the region of the screen you want to record by clicking on the "+" button in the "Sources" panel.
Choose the video settings (quality, resolution, and frame rate).
Click the red button "Start Recording" button to begin the recording.
Once you've completed the recording, click the red "Stop Recording" button.
Save the image file with a relevant description.

For Mac:

Obtain and install and open QuickTime Player (free tool).
Go to File > Select New Screen Recording (or use Command + Shift + 5).
Select the area of the screen you want to capture or choose to capture the entire screen.
Click the red button button to begin the capture.
Once you've finished the recording, click the "Stop" button.
Save the image file with a informative name.

Tips and Tricks

Always verify you have sufficient capacity to save your images and video recordings.
Organize your images and recordings in order by creating directories and naming them with relevant names and descriptions.
Use distinct and descriptive descriptions, including the error type.
If the issue occurs frequently, consider recording a extended video sequence to capture all occurrences.