Documentation within Figma - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to add a comment in Figma.

Figma

figma.currentPage.[1]('This is a note for the design')

Drag options to blanks, or click blank then click option'

AinsertComment

BaddComment

CcreateComment

DcommentAdd

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'addComment' which does not exist.

Trying to use 'commentAdd' which is not a valid method.

In Figma's plugin API, createComment is used to add a comment to the current page.

2fill in blank

medium

Complete the code to select a frame by its name in Figma.

Figma

const frame = figma.currentPage.findOne(node => node.name === [1] && node.type === 'FRAME')

Drag options to blanks, or click blank then click option'

A'Main Frame'

B"Main Frame"

CMain Frame

D'frame'

Attempts:

3 left

💡 Hint

Common Mistakes

Not using quotes around the frame name.

Using single quotes inconsistently.

Strings in JavaScript must be enclosed in quotes. Double quotes "Main Frame" correctly represent the frame name.

3fill in blank

hard

Fix the error in the code to add a text node with documentation inside a frame.

Figma

const text = figma.createText();
text.characters = [1];
frame.appendChild(text);

Drag options to blanks, or click blank then click option'

ADocumentation_text

B'Documentation text'

CDocumentation text

D"Documentation text"

Attempts:

3 left

💡 Hint

Common Mistakes

Assigning a variable name instead of a string.

Not using quotes around the text.

The characters property requires a string value, so the text must be enclosed in quotes.

4fill in blank

hard

Fill both blanks to create a rectangle and add a description as its plugin data.

Figma

const rect = figma.createRectangle();
rect.[1] = 100;
rect.setPluginData('[2]', 'This rectangle is for layout')

Drag options to blanks, or click blank then click option'

Awidth

Bheight

Cdescription

DlayoutInfo

Attempts:

3 left

💡 Hint

Common Mistakes

Confusing width and height properties.

Using an invalid key name for plugin data.

The rectangle's width is set by the width property. Plugin data keys can be any string, here 'description' is used to store notes.

5fill in blank

hard

Fill all three blanks to add a comment with a message, author, and position.

Figma

figma.createComment({ message: [1], author: [2], clientMeta: { x: [3], y: 100 } })

Drag options to blanks, or click blank then click option'

A"Review this section"

B"John Doe"

C50

D100

Attempts:

3 left

💡 Hint

Common Mistakes

Not quoting string values.

Using strings for numeric coordinates.

The message and author must be strings in quotes. The x coordinate is a number, here 50.

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