Visual Evidence Standards
Use this standard for every how-to, guide, and article.
File Naming Convention
Section titled “File Naming Convention”Use kebab-case with a stable pattern:
<topic>-<step>-<artifact>-<yyyymmdd>.png
Examples:
checkout-debug-step-1-console-errors-20260305.pngapi-validation-step-3-schema-diff-20260305.pngsecurity-audit-summary-diagram-20260305.svg
Alt Text Standard
Section titled “Alt Text Standard”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.
Required Visual Set per How-To
Section titled “Required Visual Set per How-To”Minimum visual set for each how-to page:
- One context screenshot (where the user starts).
- One action screenshot (the key action or command).
- One outcome screenshot (result, fix, or exported artifact).
Diagram Standard
Section titled “Diagram Standard”Use diagrams when sequence matters.
Required elements:
- Entry point
- 2-4 core steps
- Exit/output
- Tool calls shown as
observe,interact,analyze,generate, orconfigure
Storage and CDN
Section titled “Storage and CDN”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