A technical document needs an image. When writing a manual or release note, you should include a screenshot of a step or process. Here are some things to think about when you add an image to a piece of writing:
Make sure that the image you include is related to the steps, processes, or mechanisms you are trying to explain.
Always include a reference to an image in the description before putting it in. Also, add numbers and titles. Some tools for making documents, like Sphinx, automatically add numbers to pictures.
Use the right labels and captions. Also, the text description should match the used labels and captions. For example, if you are talking about the "Add icon" in a UX design, don't call it that in the picture and "icon to add" in the text.
Use an image if it has information that is protected by copyright. If you're using images that you borrowed, you should also hide important information.
Don't use pictures that are blurry or hard to see. When you add screenshots to a technical document (like a manual or release note), use screen capture tools like Snagit to make sure the picture is clear.
It is not necessary to add an image to the document. But it can help your audience think about how they are doing with a process. Some ideas are just too hard to understand. It is better to improve the text than to use an image.
As a bonus tip, don't make the original size of an image seem bigger or smaller than it is. It makes the text harder to read.
Keep writing. :)
Top comments (0)