Skip to main content

Dashboard documentation

Adapt sections to the target and reader; do not fill irrelevant sections.

Brief​

  1. title and scope;
  2. purpose, intended reader, and decision supported;
  3. key visible metrics with confirmed or qualified definitions;
  4. visible filters/context and what is known about their scope;
  5. how to read the first view;
  6. data-through/update context and important caveats.

Detailed​

  1. Identity and ownership: workbook/view/project and maintained-by contact only when useful and observable.
  2. Purpose and decisions: confirmed intent first; clearly label inferred purpose/audience.
  3. Metric guide: display label, business definition, calculation/source field when verified, aggregation/grain, favorable direction when known, units, and caveats.
  4. Views and charts: visible chart purpose, encodings, comparisons, axes, reference lines, annotations, and limitations.
  5. Filters and interactions: visible controls, defaults in the rendered state, verified action behavior, reset/clearing behavior, and unknowns.
  6. Usage paths: question → starting element → next view/filter → interpretation; avoid inventing thresholds or actions.
  7. Data context: datasource, scope, grain, time coverage, update timestamp/cadence only when known, exclusions, and permission caveats.
  8. Glossary: only domain terms the reader needs.
  9. Coverage/validation: evidence used, unverified definitions, and owner confirmations required.

Design observations​

Include only when requested or useful for documentation maintenance. Keep it short and unscored: visible hierarchy, legibility at the supplied render, color reliance, and potentially misleading visible framing. Do not claim WCAG conformance from an image alone or turn this into a full critique.