Espressif Manual of Style Quiz

Welcome to the Espressif Manual of Style Quiz! The quiz is still a work in progress, and we are currently finalizing the questions and answers.

Numbers

1. The development board operates at a power supply.

5V
five V
5 V

Hint:
1. Use Arabic numerals (5, not five) for measurements.
2. Use a space between the number (5) and measurement unit (V).

3. Which of the following numerical expressions are incorrect?

ESP8266 has seventeen GPIO pins.
ESP32 has 3 UART controllers.
Set the duty cycle to 90%.

Hint:
1. Use Arabic numerals (17) for 10 and greater whole numbers.
2. Spell out single-digit whole numbers.

3. Which of the following numerical expressions are correct?

10240 bits
page 10240
10,000 B.C.

Hint:
1. Use a comma “,” to mark off groups of three digits for numbers of five digits or more.
2. Do not use commas in page numbers, addresses, and decimal fractions.

4. Fix the mistakes(s) in the sentence:

80 to 240 MHz of frequency is available for the CPU clock.

Eighty to 240 MHz of frequency is available for the CPU clock.

Hint: Avoid starting a sentence with a number. A clearer way to phrase this is: The CPU clock frequency is adjustable from 80 MHz to 240 MHz.

Submit Reset

Mathematical Expressions

1. Which of the following examples correctly typesets the variable V for volume in technical documentation?

The volume is denoted as V.
The volume is denoted as V (roman type).
The volume is denoted as V.

Hint: Single-letter symbols for variables use italic; multiletter variable symbols use roman.

2. Which of the following examples uses proper formatting for multiplication in technical documentation?

2xt_CLK.
2 × t_CLK.
The formula for the area of a rectangle is a · b, where a is the length and b is the width.

Hint:
1. Avoid using the letter x, as it may be confused with a variable.
2. Use × to indicate multiplication in formulas.
3. Do not use a centered dot or the multiplication sign with single-letter scalar variables. The correct formatting for the formula in choice C is ab.
4. Leave a space before and after mathematical signs used as operators.

3. Which of the following expressions is ambiguous and needs modification?

a + b + c/d + e
a + [(b + c)/d] + e
(a + b + c)/(d + e)
a + b + (c/d) + e

Hint: a + b + c/d + e is ambiguous and could have several interpretations, such as a + [(b + c)/d] + e, (a + b + c)/(d + e), and a + b + (c/d) + e.

Submit Reset

Editing References

1. Which of the following is incorrect usage of references?

See ESP32 Datasheet > Chapter Overview.
Please visit www.espressif.com.
For information about .., refer to this document.

Hint: For online references that are formatted as hyperlinks, use descriptive text for the hyperlink; do not use blank expressions, such as “this document”.

2. For Chinese titles of books, articles, newspapers, songs, films, which of the following punctuation marks should be used?

Double quotation marks (“…”)
Book title marks (《…》)
No punctuation marks should be used

Hint: Use book title marks (《…》) for Chinese titles of books, articles, newspapers, songs, films, etc.

3. Improve the sentence:

For the pin layout of ESP32, please see Section Pin Layout > Chapter Pin Definitions > ESP32 Datasheet.

For the pin layout of ESP32, please see ESP32 Datasheet > Chapter Pin Definitions > Section Pin Layout.

Hint: Structure the references from the most general to the most specific reference..

Submit Reset

UI Elements

1. Which is the correct way to describe interaction with the following UI element in .rst or .md documents?

Toggle View Nested.
Toggle the View nested button.
Toggle View nested.

Hint:
1. Write out the UI element text exactly as it appears in the interface, including the capitalization.
2. Enclose UI element text in double backquotes (``) in .rst document and single backquotes (`) in .md documents, which will generate in-line code blocks.

2. Which is the correct way to indicate navigation through UI elements?

Go to CloudFormation in Services in the AWS Console.
Go to AWS Console -> Services -> CloudFormation.
Go to AWS Console > Services > CloudFormation.

Hint:
1. Use a greater-than symbol (>) to indicate a sequence of UI navigation steps.
2. Follow the actual order users interact with the interface.

3. Which is the correct way to describe the interaction with the following UI element in .rst or .md documents?

Click on Set Email Template.
Click at the Set Email Template button.
Click Set Email Template.

Hint: Use "Click" alone without adding "on" or "at" when describing the press-and-release action.

Submit Reset

Watermarks

1. When should the PRELIMINARY watermark be added to a document?

After the document is finalized and ready for official release.
Before the document is first released in full (e.g., version 0.5 for datasheets or 1.0 for TRMs).
Only when the document contains classified information.

Hint: The PRELIMINARY watermark signals that the content is not yet complete and may still change. It is meant to prevent confusion when the document is shared.

2. What watermark should be added when a product is outdated?

NOT RECOMMENDED FOR NEW DESIGNS.
CONFIDENTIAL.
RESTRICTED.

Hint: Use this watermark as a reminder to users that they should move to a better equivalent one for design.

3. Where should the NOT RECOMMENDED FOR NEW DESIGNS (NRND) watermark typically be placed in a document?

Only on the last page of the document.
On the title page and as footer text on all other pages.
Only on the title page of the document.

Hint: The general rule is to put the watermark on the title page and in the bottom-right footer of other pages.

Submit Reset

Admonitions

1. Which admonition is most appropriate for highlighting "Keep the port name handy, as it is needed in the next steps."?

Tip: A small convenience for the user
Note: A key reminder for the user
Important: A critical step to follow

Hint: A Tip is optional advice; Important marks mandatory steps. Keeping the port name handy is a necessary reminder to avoid problems later, but not a required step. Therefore, Note is the best choice.

2. Which admonition is most appropriate for highlighting "Incorrect configuration may cause the device to fail to boot, requiring a factory reset to recover."?

Warning: Severe risk, possible hardware damage
Caution: May cause errors or malfunction but generally recoverable
Important: A critical step that must be followed

Hint: Risk is serious but recoverable, so Caution fits best.

3. Which of the following are true about admonitions?

The severity hierarchy is: Tip < Note < Important < Caution < Warning.
A Tip can become an Important point for beginners.
You should use Warning for any irreversible action.
Overusing Warning can lead to alert fatigue.

Hint: C is false because not all irreversible actions pose serious risks that require a Warning.

Submit Reset

Provide feedback about this document