Before adding a screenshot in a procedure, analyze the complexity of the task to determine whether the screenshot is useful and provides clarity. When there are no screenshots, ensure that the procedure clearly describes windows, buttons, and other UI elements.
Ensure that you have access to an up-to-date environment to maintain screenshots. Check the interface frequently to ensure that your content is correct. If you do not have access to the interface, ask the development team to help you get the screenshots you need.
Before using screenshots, consider the following:
The Avaya DITA/XML information model uses a structured approach with clear, simple procedures. This reduces the need for screenshots for simple tasks. You might still need screenshots for complex tasks.
Usability studies show that users can confuse screenshots with the real application.
The placement of screenshots is important. Large screenshots force the user to scroll down, which can slow down their access to the next piece of information.
Content that uses text is more accessible to users with certain disabilities than content with images. For example, a screenshot can confuse users with vision loss who require a screen reader.
Adding and maintaining screenshots can take a lot of time. When you add the image, you might need to edit it to ensure that it does not show real names and contact information. If the interface changes frequently, you must revise and edit the image each time there is a change. Consider whether the value the screenshot provides outweighs the amount of work required.
