Skip to content

Visual Evidence Standards

Use this standard for every how-to, guide, and article.

Use kebab-case with a stable pattern:

<topic>-<step>-<artifact>-<yyyymmdd>.png

Examples:

  • checkout-debug-step-1-console-errors-20260305.png
  • api-validation-step-3-schema-diff-20260305.png
  • security-audit-summary-diagram-20260305.svg

Every image must have meaningful alt text.

Template:

<Artifact type> showing <what changed or matters> for <task/context>.

Examples:

  • Screenshot showing failed checkout request with 422 schema mismatch for cart update.
  • Diagram showing triage flow from observe to analyze to generate in Gasoline Agentic Devtools.

Minimum visual set for each how-to page:

  1. One context screenshot (where the user starts).
  2. One action screenshot (the key action or command).
  3. One outcome screenshot (result, fix, or exported artifact).

Use diagrams when sequence matters.

Required elements:

  • Entry point
  • 2-4 core steps
  • Exit/output
  • Tool calls shown as observe, interact, analyze, generate, or configure

Store originals in the media repo, then publish optimized web formats to CDN.

  • Master source: lossless PNG/SVG/WebM in media repo
  • Delivery: optimized WebP/AVIF/SVG via CDN
  • Keep docs repo references stable with absolute CDN URLs