KB User's Guide - Documents Tab - Image Guidelines

This document explains guidelines for images included in your KB documents, including standards for formatting, sizing, and displaying.

Image Guidelines

  • Use the .png format if possible, otherwise use one of the following file formats: .jpg, .gif.
  • If possible, try to make your images no wider than 600px. This ensures that users with XGA resolution (1024x768) displays can view your content without a scroll bar and is more accessible for smartphone users.
  • The size of the image must be under 125MB when using the the multi-select uploader in Firefox, Chrome and Safari.  A progress bar will display a confirmation (or error) message. Unfortunately, this does not work in IE, so IE will not have any multi-select feature and is still limited to 40MB files.
  • You must insert appropriate alt text for accessibility purposes.
  • The image should be clear and readable.
  • Use red outlines to highlight important buttons, text fields, or other information in images.


Tips

  • Avoid huge screenshots.
  • Don't take screenshots of a huge window if you're only interested in one button unless you are trying to show the user where to find that one button on the screen. Crop out the important part. 
  • Make sure to save as PNG or JPG, GIF.
  • Give your screenshots descriptive names. If your screenshots are named kb4643_01, kb4643_02, etc, it will be very confusing to make edits to the document and/or screenshots.
  • Make sure the document makes sense even without the screenshots. Screenshots are supposed to add to the document, your document should be fully comprehensible without them.

    badexample.png

  • This is a bad screenshot because it's far too big for the information it contains and the rounded rectangle is too tight on the text.

    okayexample.png

  • This is an okay screenshot because the rounded rectangle is just right but the image is a bit big.

    goodexample.png

  • This is a good screenshot because the rounded rectangle is just right and the image size is just right for the content.

Capturing screenshots

See Also:




Keywords:kbadmin knowledgebase tools users guide screenshots guidelines help format rules images image   Doc ID:4643
Owner:Teresa A.Group:KB User's Guide
Created:2006-04-27 18:00 CSTUpdated:2016-08-29 15:33 CST
Sites:KB Demo, KB Demo - Child Demo, KB User's Guide
Feedback:  1   1