Knowledge Base contributors can insert images in into their articles to illustrate the directions they give to end users , or to clarify the information they present.
...
Appropriate Use of Screenshots
You should use Use screenshots when the instructional steps are complex or several actions are incorporated into a step or into many steps.
- You will need to use Use your best judgement when deciding whether or not to add a screenshot. Consider if it is it really necessary to insert an image.
- Can I still clearly convey this information to the end user by writing it out?
- Will adding an image to this step add any value for the end user?
...
All KB contributors should use a standard image capturing method . Doing so will to allow for consistency across all Knowledge Base articles.
PCs and Macs have different image capturing methods. Use the method that is appropriate for your operating system.
PC
- On PCs, use Use the Snipping Tool.
- Make sure you take your snip at a high enough zoom so that the resolution is maintained once you place your image into the article.
Mac
- On Macs, use Use the print screen function and crop the image.
Make sure that the section you want to crop is not too small and that it will retain a high resolution when you input the image to your article.
Tip title Tip When you are writing an article in edit mode, you can always size down an image if it is too large for the page. However, you cannot enlarge the image if it is too small. Therefore, when you take a screenshot, you should aim to capture as large an image as you can.
Images on the Page
Image
...
Size
Screenshots should be big enough to get the point across without having to click on or enlarge the image.
However, images that are too large can disrupt the end user's experience. Again, judgement here is essential. You will need to ensure that you size the image so that:
- It does not extend past the text around it.
- It is not too small either.
Make sure your image is not blurry.
...
Screenshots should be inserted below the written instructions. Add a space after the image if necessary so it doesn't does not run into unrelated steps below it.
To add this space,
- Place the cursor at the end of the preceding line of text.
- If the previous line contained an image, place the cursor at the every end of the image.
- Hold down the Shift key.
- Press Enter. The cursor will shift to the next line without disrupting existing number formatting.
- Press Shift + Enter again. You can, then, proceed with the rest of your article.
Inputting Alternate Text (Alt Text)
Alternate text helps to provide context of images to images for users who use screen readers and other assistive tools by describing an image's content in words. When you add alternate text (also known as alt text) to an image, you do so under one of two conditions. You are either:
...
Images with Explanatory Text
In this case, an explanation for the purpose of the image is in the text above an image. Thus, to avoid redundancy, use null alt text. To put in null alt text, just enter double quotes ("") into the alt text dialogue box.
...
In this case, there is no explanation for the purpose of an image in the text above it. Because there is no explanatory text above the image, you should use descriptive alt text.
...