Documentation and naming conventions in Tableau - Cheat Sheet & Quick Revision

Recall & Review

beginner

Why is documentation important in Tableau dashboards?

Documentation helps others understand your dashboard's purpose, data sources, and calculations. It makes maintenance and updates easier and improves collaboration.

beginner

What is a good practice for naming Tableau worksheets?

Use clear, descriptive names that reflect the content or purpose, like 'Sales by Region' instead of 'Sheet1'. This helps users find and understand worksheets quickly.

beginner

How should calculated fields be named in Tableau?

Name calculated fields clearly to describe what they calculate, such as 'Total Sales' or 'Profit Margin %'. Avoid vague names like 'Calc1' to reduce confusion.

intermediate

What is the benefit of using comments in Tableau calculations?

Comments explain why a calculation is done a certain way. They help others (and your future self) understand complex logic without guessing.

intermediate

What should you include in Tableau dashboard documentation?

Include data source details, calculation explanations, filter descriptions, and update instructions. This makes the dashboard easier to use and maintain.

What is the best way to name a Tableau worksheet?

A Use descriptive names related to content

B Use default names like Sheet1, Sheet2

C Use random numbers

D Use abbreviations only

Descriptive names help users understand the worksheet's purpose quickly.

Why add comments inside Tableau calculated fields?

A To change data sources

B To make calculations run faster

C To hide calculations

D To explain calculation logic

Comments clarify complex logic for anyone reading the calculation.

Which is NOT a good practice for Tableau documentation?

A Using vague terms like 'stuff'

B Describing data sources

C Explaining filters

D Including update instructions

Vague terms confuse users and reduce documentation quality.

What should calculated field names avoid?

A Clear descriptions

B Vague names like Calc1

C Meaningful terms

D Relevant keywords

Vague names make it hard to understand what the calculation does.

Good documentation in Tableau dashboards helps with:

A Hiding data sources

B Slowing down performance

C Collaboration and maintenance

D Making dashboards look complex

Clear documentation improves teamwork and makes updates easier.

Explain why clear naming conventions are important in Tableau dashboards.

Think about how you find things easily in a well-organized folder.

Describe what key information should be included in Tableau dashboard documentation.

Imagine explaining your dashboard to a new team member.

Practice

1. Why is it important to use clear and consistent naming conventions in Tableau?

easy

A. It makes Tableau run faster.

B. It helps users understand and maintain dashboards easily.

C. It automatically creates visualizations.

D. It reduces the file size of Tableau workbooks.

Solution

1. Step 1: Understand the purpose of naming conventions

   Clear and consistent names help users quickly understand what each field or dashboard represents.

2. Step 2: Connect naming to maintenance

   When names are clear, it is easier to update or fix dashboards later without confusion.

3. Final Answer:

   It helps users understand and maintain dashboards easily. -> Option B

4. Quick Check:

   Clear naming = easier understanding and maintenance [OK]

Hint: Clear names make dashboards easy to read and update [OK]

Common Mistakes:

• Thinking naming affects performance
• Assuming Tableau auto-documents everything
• Ignoring the importance of maintenance

2. Which of the following is the best practice for naming a calculated field in Tableau?

easy

A. Use descriptive names like Total Sales 2023.

B. Use vague names like Calc1 or FieldX.

C. Use special characters like Total$Sales!.

D. Use very long names with unnecessary details.

Solution

1. Step 1: Identify clear and descriptive naming

   Descriptive names explain what the field calculates, making it easier to understand.

2. Step 2: Avoid vague or confusing names

   Names like Calc1 or special characters can confuse users and cause errors.

3. Final Answer:

   Use descriptive names like Total Sales 2023. -> Option A

4. Quick Check:

   Descriptive names improve clarity [OK]

Hint: Name fields clearly to describe their purpose [OK]

Common Mistakes:

• Using generic names like Calc1
• Including special characters that cause errors
• Making names too long and confusing

3. Given a Tableau calculated field named Profit Margin with the formula [Profit] / [Sales], what would be the best description to add in the documentation?

medium

A. "Calculates the ratio of profit to sales as a percentage."

B. "Counts the number of sales transactions."

C. "Shows total sales amount."

D. "Filters data by profit values."

Solution

1. Step 1: Understand the formula meaning

   The formula divides profit by sales, which calculates profit margin as a ratio.

2. Step 2: Match description to calculation

   The description should explain this ratio clearly, not unrelated actions like counting or filtering.

3. Final Answer:

   "Calculates the ratio of profit to sales as a percentage." -> Option A

4. Quick Check:

   Description matches calculation purpose [OK]

Hint: Match description to what the formula actually does [OK]

Common Mistakes:

• Confusing calculation with counting or filtering
• Writing vague or unrelated descriptions
• Ignoring the formula's actual logic

4. You see a Tableau dashboard with field names like Fld1, Fld2, and no comments or descriptions. What is the main problem here?

medium

A. The dashboard uses too many colors.

B. The dashboard will not load in Tableau.

C. The dashboard will show incorrect data.

D. The dashboard is hard to understand and maintain.

Solution

1. Step 1: Identify the impact of poor naming

   Names like Fld1 are vague and do not explain what data they hold.

2. Step 2: Understand the effect of missing documentation

   Without comments or descriptions, users cannot easily understand or update the dashboard.

3. Final Answer:

   The dashboard is hard to understand and maintain. -> Option D

4. Quick Check:

   Vague names + no docs = poor usability [OK]

Hint: Vague names cause confusion and maintenance issues [OK]

Common Mistakes:

• Assuming dashboard won't load due to naming
• Thinking data will be incorrect without comments
• Focusing on colors instead of naming issues

5. You are creating a Tableau project for sales analysis. Which combination of documentation and naming conventions will best help your team collaborate and maintain the project?

hard

A. Use special characters in names; write long paragraphs in descriptions; skip comments.

B. Use short random names; avoid descriptions; rely on memory for dashboard logic.

C. Use clear, consistent field names; add descriptions to calculated fields; comment dashboards.

D. Name fields with numbers only; add no descriptions; use colors to explain logic.

Solution

1. Step 1: Identify best naming practices

   Clear and consistent names help everyone understand the data fields easily.

2. Step 2: Recognize importance of documentation

   Descriptions and comments explain calculations and dashboard logic, aiding collaboration and maintenance.

3. Step 3: Eliminate poor practices

   Random names, missing descriptions, or relying on colors alone cause confusion and errors.

4. Final Answer:

   Use clear, consistent field names; add descriptions to calculated fields; comment dashboards. -> Option C

5. Quick Check:

   Clear names + docs = better teamwork [OK]

Hint: Combine clear names with comments and descriptions [OK]

Common Mistakes:

• Skipping documentation assuming names are enough
• Using unclear or random field names
• Relying on colors instead of text explanations