Skip to main content

Report Template

Canonical output shape. Follow this exactly. Do not add sections. Do not remove sections. Do not reorder.

Chat vs. file rendering. The Tableau Agent chat panel does not render markdown — #, ##, **, and --- show up as literal characters, not formatting. The section structure and content below apply in both destinations, but the punctuation differs:

  • Writing to a file (.md or .txt in Downloads): use the markdown syntax exactly as shown in this document.
  • Posting in chat: strip markdown syntax. Section headers become a plain line in ALL CAPS (e.g. CRITICAL instead of ### Critical, NOT SCANNED instead of ## Not Scanned). Bold (**...**) becomes plain text. The --- horizontal rule before the footer is omitted; just start the footer line on its own line. Hyphen bullets (- ) stay as-is — those render fine as plain text.
# Spellcheck Report: <Workbook Name>

Scanned: <YYYY-MM-DD HH:MM>
Categories included: <comma-separated list from Step 1 scope confirmation>
Allow-list: <path>, <N> terms loaded
Dictionary: <en-US | fallback built-in word list>

Findings summary:
- Critical: <N>
- High: <N>
- Medium: <N>
- Low: <N>
- Total: <N>

Sheets scanned: <N> of <M> (<M-N> in Not Scanned section)

Findings sections​

One section per severity, in order: Critical → High → Medium → Low. Skip any severity that has zero findings (state "None" under the heading, do not omit the heading).

Within each severity, group by location. A "location" is one worksheet OR one dashboard OR the "Datasource fields" bucket for aliases and calc names.

Format for each finding:

### <Severity>

#### Location: <Worksheet or Dashboard or "Datasource fields">

- **"<exact string as written>"** in <element type, e.g., "Title" or "Tooltip" or "Alias for [Customer Segment]">
- Issue: <one-line description>
- Suggestion: <suggested fix if confidence is high; "Consider allow-listing if intentional" if not>

Example:

### Critical

#### Location: Executive Dashboard

- **"Cusomer Revenue by Segment"** in Dashboard title
- Issue: "Cusomer" is not in dictionary (distance 1 from "Customer")
- Suggestion: "Customer Revenue by Segment"

Not Scanned section​

Always present, even if empty. If any sheet could not be read after both Tier 1 and Tier 2, list it here with the reason.

## Not Scanned

- <Sheet name>: <reason, e.g., "get-worksheet-xml failed and no .twb path provided">

If empty:

## Not Scanned

None. All sheets scanned successfully.

Allow-list suggestions​

Terms flagged 3 or more times that the user may want to add to skill-expertise/allow-list.txt. Sort by frequency descending.

## Allow-list suggestions

Terms flagged 3+ times, likely intentional jargon:
- <term> (flagged <N> times)
- <term> (flagged <N> times)

If none:

## Allow-list suggestions

None. No repeated unknown tokens.

Spot-check section (only when total findings > 20)​

Present only when the mandatory-verification spot-check ran. Omit entirely (no heading) when total findings ≤ 20.

## Spot-check

Total findings exceeded 20, so 3 findings were re-verified against source:
- Critical (first): "<string>" in <location> — confirmed
- High (middle): "<string>" in <location> — confirmed
- Medium (last): "<string>" in <location> — confirmed
***

Report generated by desktop-spellcheck. All findings are advisory. Fix in Tableau Studio manually. Re-run after edits to confirm.

What NOT to include​

  • Do not include a "Recommendations" section beyond the per-finding suggestions.
  • Do not include an executive summary or narrative wrap-up.
  • Do not include token counts, file sizes, or performance metrics.
  • Do not editorialize on the workbook's overall quality.
  • Do not use emoji or decorative characters. This is a working document.