Reviewing Images in the Knowledge Base
In this article
If there is only one image in an article, more leniency can be applied. There shouldn't be more than one image per-section unless is pertinent. These things should be considered when removing images:
- They illustrate a simple command like Click Next, Click Install, or Click Finish.
- The image depicts what they are seeing on-screen with no enhancements or highlight.
- Unless it is to specifically confirm what they should see.
- If there is one image that sums up previous images
- If each step adds to an image and the final step includes them all, it may be best to only include that final image.
- CAS, Duo, and login screens should be removed in most cases.
- Unless the article is specifically addressing those elements.
Contacting the Content Owner
Try to recreate the image if you have access and it is not too time-consuming. You may need to request that the content owner recreate the image if:
- The image is too small and not scalable.
- Try to enlarge it within the article first.
- If the image is useful but blurry or has other quality issues.
Rarely is necessary to upload images as attachments. It is also not recommended to use the show attachments option. When this happens:
- Download the attachments.
- Make any potential edits.
- Upload them to the Image Library or through the insert/edit image icon in the article editing screen.
- When uploading directly through the article, select Image Library.
- Remove the attachments from the article.
When to correct images
It is very common for screenshots to include completely unnecessary elements like the website headers or other elements of a page's layout. These things change frequently and can cause confusion about the validity of otherwise relevant images. Here are things to consider when deciding about editing an image:
- They are not cropped well or at all.
- Get in as close as you can.
- Something needs to be highlighted.
- A step may mention a small piece of what is shown in a screenshot. You may have to add the standard red box around the element and crop if needed.
- You should remove or blur last names, emails, and other potentially sensitive information.
- In some cases, you may need to insert fake information to illustrate the format of information.
- For example, if a university email needs to mentioned you might list firstname.lastname@example.org.
- The useful image does not fit within the body of the article and requires a scroll slider.
- Gifs and videos are exceptions.
- You can try to shrink the gif as you would a standard image as long as it retains readability.
- Download the image.
- Directly from the article if it is large enough (drag to desktop or right click to save as).
- From the Image library.
- Make your edits.
- Most edits (like cropping, highlighting, and removing names) can be made in an OS default editor like Preview on MacOS and Paint on Windows.
- Jing is a popular alternative.
- Photoshop is also available to the UMD community.
- Save the file with a new name.
- The file name should combine the service or software and the action or screen.
- Example: AdobeEnterpriseSelection (this can be easily searched).
Uploading and adding images to articles
Step-by-step instructions for uploading and adding images to an article can be found in the images section of the Knowledge Management Style Guide.