TDX Knowledge: Create Effective Images

Images can make it easier to follow instructions in a KB article. The most effective images do one of the following:

  • Show what something looks like
  • Help the user locate something
  • Provide confirmation of settings

Before inserting an image in an article

Before inserting any images to your KB articles, make sure the document makes sense without screenshots. The text should stand on its own, should be concise, clear, and easy to scan.

  • Not every step requires an image. Consider the complexity of the interface and associated instructions when determining whether or not to use one. 

Creating images

Once you have determined the need for an image, Take a Screenshot. Then edit the image as needed.

You may need to Crop and Resize Images for Use in an Article.

You may also need to highlight areas in an image to focus the user's attention.

Focusing your images

Crop your screenshots so only the most pertinent information is included; this will allow the user to efficiently scan the image and find what they are looking for. Cropping screenshots also helps keep the KB article clean and clutter-free.

Use arrows, boxes, or other types of call-outs to highlight important aspects of the image. Our standard is to use the color red.

Example images

  • Before cropping: The dialog box image below shows more than the pertinent information.
  • After cropping: The image now focuses on the relevant information.

    Before and after images of a dialog window that has been cropped and resized.
     
  • Before cropping and resizing: The menu image below is larger than it needs to be and has clutter on both sides. 
  • After cropping and resizing: The image is appropriately sized and the clutter has been removed. 
    Example of a dialog window that was cropped and resized. The final result is uncluttered.
  • Before: The dialog box below is very large and only a small part is relevant as indicated by the red rectangle calling out the pertinent command.
    Example of the large dialog window that provides context but only has one small part that is relevant.
    • If it's important for the viewer to see the full context of the window, you can reduce the size of the image and provide a pop-out of the relevant part to make the image more useful.
  • After: The dialog box has been sized appropriately and the call-out remains highlighting the pertinent command. The call-out now includes an arrow pointing to a pop-out of the relevant portion of the dialog box again with the pertinent command called out with a red rectangle. 
    Example of a once large image that still provides context but now points to larger pop-out highlighting the relevant part of the screen.

Additional resources

TDX ID
3670