Selecting the right images is crucial for enhancing the effectiveness of technical documentation. Images should always add value by providing clarity, illustrating steps, or offering visual confirmation of the information being presented.
Relevance:
- Choose images that directly support the text: Every image should have a clear purpose and be relevant to the content. Use screenshots, diagrams, charts, and illustrations that help the reader understand a process, concept, or piece of information. Example: A screenshot showing the location of a button mentioned in the instructions.
- Avoid decorative or unrelated images: Refrain from using images that are merely decorative or that do not add meaningful information to the documentation. This helps maintain focus on the content and avoids unnecessary distractions.
Clarity and Quality:
- Use high-resolution images: Ensure that all images are of high quality, with clear resolution and sharp details. Low-quality images can appear blurry or pixelated, detracting from the professionalism of the documentation.
- Ensure clarity of content within images: The key elements of the image should be easily distinguishable. Avoid overly complex images that may confuse the reader. For example, a diagram should be simple and direct, without excessive detail that could obscure the main points.
Consistency:
- Maintain a consistent style: Use a consistent style for all images throughout the documentation. This includes uniform use of fonts, colours, and iconography. Consistent styling helps create a cohesive and professional look.
- Align with brand guidelines: Ensure that all images, particularly icons, diagrams, and illustrations, align with WriteTech Hub’s branding guidelines, including the use of approved colour palettes and fonts.
Dos:
- Select images that enhance understanding: Example: Use a diagram to illustrate a process flow.
- Use high-resolution images: Example: Ensure screenshots are clear and legible.
Don’ts:
- Don’t use decorative or irrelevant images: Avoid stock photos that do not add value.