Visual elements

Screen captures

Use screen captures only when necessary (for example, to complete a procedure or illustrate a concept).

Minimize the size, particularly the capture width. This ensures that the image renders well in narrow windows. Use the zoomable class on large images.

If the captured content has no natural border, follow these guidelines:

  • Trim the capture to its non-white content.

  • Add a 10px white padding.

  • Add a soft gray border (1px solid #d6d6d6d border).

Always use PNG format (not JPG).

Avoid masking, blurring, or redacting sensitive text content, rather take the time to enter dummy text (see Taking Screen Captures in the Coveo Administration Console).

Avoid drop shadows.

Don’t include sensitive data in captures.

Use placeholder names, such as example.com for a domain and John Doe for a user.

Diagrams

Follow the Diagram Style Guide.

Done preferably with draw.io and saved to Google Dive:

  • Shared with all Coveo employees with Anyone at Coveo can find and access.

  • Shared with all documentation team members with Can edit.

  • Add a hidden comment indicating the draw.io URL in the article where it is used.

Gifs

Animated.

Must show a series of actions.

Use with parsimony.

Use fade-ins and fade-outs to let the user know when it starts and finishes.

Maximum length: 15 seconds.

Logos

Coveo:

  • Reproduce logos from the Administration Console source addition panel.