Dashboard documentation
Adapt sections to the target and reader; do not fill irrelevant sections.
Brief
- title and scope;
- purpose, intended reader, and decision supported;
- key visible metrics with confirmed or qualified definitions;
- visible filters/context and what is known about their scope;
- how to read the first view;
- data-through/update context and important caveats.
Detailed
- Identity and ownership: workbook/view/project and maintained-by contact only when useful and observable.
- Purpose and decisions: confirmed intent first; clearly label inferred purpose/audience.
- Metric guide: display label, business definition, calculation/source field when verified, aggregation/grain, favorable direction when known, units, and caveats.
- Views and charts: visible chart purpose, encodings, comparisons, axes, reference lines, annotations, and limitations.
- Filters and interactions: visible controls, defaults in the rendered state, verified action behavior, reset/clearing behavior, and unknowns.
- Usage paths: question → starting element → next view/filter → interpretation; avoid inventing thresholds or actions.
- Data context: datasource, scope, grain, time coverage, update timestamp/cadence only when known, exclusions, and permission caveats.
- Glossary: only domain terms the reader needs.
- 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.