Image is an essential element of a technical document. While preparing a technical document, you need to include a screenshot for processes or steps. Here are some points to consider:
Ensure an image correlates with the mechanisms, processes, or steps that you are trying to clarify.
Always reference an image in the description before its placement. Also, include numbers and titles. Some document generator tools like; Sphinx automatically generate numbers for images.
Use an appropriate label and caption. Besides, used label and caption should match the text description. For instance, if you are describing the "Add icon" of a UX design, do not call it "Add icon" in the image and "icon to add" in the text.
Use an image when it contains copyrighted information. Also, anonymize information if you are using borrowed images.
Avoid using blurry and unclear images. While adding screenshots in a technical document (manual and release note), take a clear picture using screen capture tools such as; Snagit.
An image are not mandatory. However, it can help your audience to self-evaluate a process. Some concepts are so complex. Instead of using an image, it is best to enhance a text.
- Finally, do not exaggerate or misinterpret the original scale of an image. It affects the readability of the text.