Documentation within Figma - Dashboard Guide

Dashboard Mode - Documentation within Figma

Goal

Understand how to add clear documentation inside Figma files to help teams use and maintain BI dashboards effectively.

Sample Data

Component	Description	Notes
Sales KPI Card	Shows total sales amount	Uses SUM of sales data
Sales Trend Chart	Line chart of sales over months	Helps identify seasonality
Region Filter	Dropdown to select sales region	Filters all visuals
Data Source Info	Text block describing data origin	Updated monthly
Calculation Notes	Text explaining formulas used	Includes DAX expressions

Dashboard Components with Documentation

• Sales KPI Card: Displays total sales using formula SUM(Sales[Amount]). Shows 600 for sample data.
• Sales Trend Chart: Line chart plotting monthly sales totals. Helps spot trends and peaks.
• Region Filter: Dropdown control that filters all visuals by selected region.
• Data Source Info: Text box inside Figma describing the data source as "Sales data from internal ERP system, updated monthly."
  Helps new users understand data origin.
• Calculation Notes: Text box explaining key formulas, e.g., "Total Sales calculated as SUM of Sales Amount column."
  Supports transparency and easier maintenance.

Dashboard Layout (ASCII Art)

+----------------------+-----------------------+
| Sales KPI Card       | Data Source Info      |
| (Top-left)           | (Top-right)           |
+----------------------+-----------------------+
| Sales Trend Chart                          |
| (Full width below KPI and Info)           |
+-------------------------------------------+
| Region Filter                              |
| (Bottom, full width)                       |
+-------------------------------------------+
| Calculation Notes                          |
| (Footer, full width)                       |
+-------------------------------------------+
  

Interactivity

The Region Filter dropdown controls which region's data is shown in the Sales KPI Card and Sales Trend Chart. Selecting a region updates these visuals instantly.

The Data Source Info and Calculation Notes are static text elements providing context and do not change with filters.

Self Check

If you select "East" in the Region Filter, which components update?

• Sales KPI Card updates to show total sales for East region only.
• Sales Trend Chart updates to show monthly sales trend for East region.
• Data Source Info and Calculation Notes remain unchanged.

Key Result

A Figma dashboard with sales KPIs, trend chart, region filter, and embedded documentation for clarity.

Practice

1. What is the main purpose of adding documentation within Figma designs?

easy

A. To make designs easy to understand for everyone

B. To increase the file size unnecessarily

C. To hide design elements from viewers

D. To create complex animations automatically

Solution

1. Step 1: Understand the role of documentation in design

   Documentation helps explain design decisions and details clearly.

2. Step 2: Identify the benefit for teamwork

   Clear documentation improves communication and saves time for teams.

3. Final Answer:

   To make designs easy to understand for everyone -> Option A

4. Quick Check:

   Documentation purpose = clarity [OK]

Hint: Think about why notes help teammates understand designs [OK]

Common Mistakes:

• Confusing documentation with design decoration
• Thinking documentation hides elements
• Assuming documentation creates animations

2. Which of the following is a correct way to add documentation inside a Figma file?

easy

A. Hide all text layers to keep file clean

B. Delete all unused layers without notes

C. Use comments and text layers to add notes

D. Only use external documents, not Figma itself

Solution

1. Step 1: Identify documentation methods in Figma

   Comments and text layers are built-in ways to add notes directly on designs.

2. Step 2: Recognize why other options are incorrect

   Deleting layers or hiding text removes documentation; external docs are less integrated.

3. Final Answer:

   Use comments and text layers to add notes -> Option C

4. Quick Check:

   Documentation methods = comments + text layers [OK]

Hint: Remember Figma supports comments and text for notes [OK]

Common Mistakes:

• Thinking documentation means deleting layers
• Assuming external docs replace Figma notes
• Hiding text layers removes documentation

3. Given a Figma file with multiple pages, which page is best suited for detailed documentation notes?

medium

A. The first page with only images

B. A dedicated page named 'Documentation' or 'Notes'

C. The page with the most complex design

D. A hidden page with no access

Solution

1. Step 1: Understand page organization in Figma

   Using a dedicated page for documentation keeps notes organized and easy to find.

2. Step 2: Evaluate other options

   Notes on complex design pages or hidden pages reduce clarity and accessibility.

3. Final Answer:

   A dedicated page named 'Documentation' or 'Notes' -> Option B

4. Quick Check:

   Best documentation location = dedicated page [OK]

Hint: Use a separate page for notes to stay organized [OK]

Common Mistakes:

• Putting notes on complex design pages
• Hiding documentation pages
• Mixing notes with images only

4. You added comments in Figma but teammates say they can't see them. What is the likely issue?

medium

A. Comments require a paid plugin to be visible

B. Comments automatically delete after 24 hours

C. Comments only appear in exported PDFs

D. Comments were added but not resolved or viewed

Solution

1. Step 1: Check how Figma comments work

   Comments stay visible until resolved or dismissed by users.

2. Step 2: Understand common misconceptions

   Comments do not auto-delete, are visible in the app, and need no plugins.

3. Final Answer:

   Comments were added but not resolved or viewed -> Option D

4. Quick Check:

   Comments visibility = unresolved and viewed [OK]

Hint: Check if comments are unresolved and teammates have viewed them [OK]

Common Mistakes:

• Believing comments auto-delete
• Thinking comments show only in exports
• Assuming plugins are needed for comments

5. How can you best combine Figma documentation features to ensure your design is clear and easy to follow for a large team?

hard

A. Use a dedicated documentation page, add comments on key elements, and include descriptive text layers

B. Only add comments and avoid text layers to keep the file simple

C. Create multiple hidden pages with notes to avoid clutter

D. Export designs without notes and send separate documents

Solution

1. Step 1: Identify best practices for documentation in Figma

   Combining a dedicated page, comments, and text layers covers different documentation needs clearly.

2. Step 2: Evaluate drawbacks of other options

   Using only comments or hidden pages reduces clarity; separate docs break workflow.

3. Final Answer:

   Use a dedicated documentation page, add comments on key elements, and include descriptive text layers -> Option A

4. Quick Check:

   Comprehensive documentation = page + comments + text [OK]

Hint: Combine pages, comments, and text for clear documentation [OK]

Common Mistakes:

• Relying on only one documentation method
• Hiding notes instead of organizing them
• Separating docs from Figma file