Stay organized with collections
Save and categorize content based on your preferences.
To give the reader important or useful information that isn't part of the flow of the text, you
can offset the information with a notice. However, there's
evidence
that readers skip elements on the page, including notices, that are outside their focus of
interest. If you're not sure whether something should be a notice, write it first in regular text
and then decide if a notice is needed.
Don't use too many notices. When you use multiple notices on a page, they begin to lose their
visual distinctiveness. See if you can convey the information in a different way. This is
especially true if you have two (or more) notices in a row.
Where possible, avoid grouping two or more notices together. If you find it
necessary to do so (for example, a note with a caution inside it, or several
warnings one after another), consider reorganizing the content.
Pick a notice type
The following is a list of commonly used notices.
Note
An ordinary aside or tip. Provides information that is useful but not critical to the reader.
For example, "Generating excessive amounts of traffic to external systems can resemble a
denial-of-service attack." For more information, see
when to use
and when not to use a note notice type.
Caution
Tells the reader to proceed carefully. For example, "We don't recommend using a
broad 0.0.0.0/0 range that would allow all traffic."
Warning
Stronger than a caution notice; it means "Don't do this" or that this step might be
irreversible, such as leading to permanent data loss. If a reader doesn't heed the warning, they
can lose money, lose work, or open themselves to a security breach. For example, "Don't put a
password on the command line; doing so is a security risk."
Success
Describes a successful action or an error-free status. Used only in interactive or dynamic
content; don't use this notice type in ordinary static pages. For example, "You've successfully
deployed an application to GKE."
When to use a note notice type
Create a note when all of the following are true:
The information you're sharing is relevant but not
necessary to what the reader is doing right now. If the reader skips
the information, they'll still succeed.
Interrupting the reader at this point is not an obstacle to the reader. For example, your
note isn't suggesting an alternative that leads the reader down a
different path.
The information is not part of the flow of what you're writing—it's not just
a continuation, a result, or a pointer to additional information.
Don't use notes to tell the reader about prerequisites or about
steps they should have taken earlier. Information like this should precede the
step.
Don't make a full procedural step into a note.
Don't use notes to provide information that's necessary for the
reader to succeed.
Don't use notes for information that's in flow with the preceding
text. For example, don't use a note to state expected results or to
include information that simply describes what precedes.
Examples
Use whatever visual presentation for notices is standard for your site.
If you're writing in HTML and your site doesn't specify what HTML to use for
notices, we recommend using HTML code similar to the following example:
<aside class="note"><b>Note:</b> All VPC networks include firewall
rules.</aside>
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-18 UTC."],[[["\u003cp\u003eNotices highlight useful information outside the main text flow, but readers may overlook them.\u003c/p\u003e\n"],["\u003cp\u003eMinimize notice usage, as overuse diminishes their effectiveness and consider alternative ways to convey the information.\u003c/p\u003e\n"],["\u003cp\u003eChoose from four notice types: Note, Caution, Warning, and Success, each serving a distinct purpose.\u003c/p\u003e\n"],["\u003cp\u003eNotes provide relevant but non-critical information, while Cautions advise careful proceeding, and Warnings highlight potential risks or irreversible actions.\u003c/p\u003e\n"],["\u003cp\u003eSuccess notices indicate positive outcomes but are restricted to interactive content.\u003c/p\u003e\n"]]],["Notices offset non-essential information, but overuse diminishes their impact. Limit notices, avoid grouping them, and prioritize integrating information into the main text. There are four types: *Note* (useful but not critical information), *Caution* (proceed carefully), *Warning* (avoid due to potential consequences), and *Success* (successful actions, for dynamic content only). Notes should be relevant but non-essential, not interrupt the reader's flow, and must not contain the flow or necessary information.\n"],null,["# Notes, cautions, warnings, and other notices\n\nTo give the reader important or useful information that isn't part of the flow of the text, you\ncan offset the information with a notice. However, there's\n[evidence](https://www.nngroup.com/articles/tunnel-vision-and-selective-attention/)\nthat readers skip elements on the page, including notices, that are outside their focus of\ninterest. If you're not sure whether something should be a notice, write it first in regular text\nand then decide if a notice is needed.\n\nDon't use too many notices. When you use multiple notices on a page, they begin to lose their\nvisual distinctiveness. See if you can convey the information in a different way. This is\nespecially true if you have two (or more) notices in a row.\n\nWhere possible, avoid grouping two or more notices together. If you find it\nnecessary to do so (for example, a *note* with a *caution* inside it, or several\n*warnings* one after another), consider reorganizing the content.\n\nPick a notice type\n------------------\n\nThe following is a list of commonly used notices.\n\nNote\n: An ordinary aside or tip. Provides information that is useful but not critical to the reader.\n For example, \"Generating excessive amounts of traffic to external systems can resemble a\n denial-of-service attack.\" For more information, see\n [when to use](#when-to-use-a-note-notice-type)\n and [when not to use](#when-not-to-use-a-note-notice-type) a note notice type.\n\nCaution\n: Tells the reader to proceed carefully. For example, \"We don't recommend using a\n broad `0.0.0.0/0` range that would allow all traffic.\"\n\nWarning\n: Stronger than a *caution* notice; it means \"Don't do this\" or that this step might be\n irreversible, such as leading to permanent data loss. If a reader doesn't heed the warning, they\n can lose money, lose work, or open themselves to a security breach. For example, \"Don't put a\n password on the command line; doing so is a security risk.\"\n\nSuccess\n: Describes a successful action or an error-free status. Used only in interactive or dynamic\n content; don't use this notice type in ordinary static pages. For example, \"You've successfully\n deployed an application to GKE.\"\n\nWhen to use a *note* notice type\n--------------------------------\n\nCreate a *note* when all of the following are true:\n\n- The information you're sharing is *relevant* but not *necessary* to what the reader is doing right now. If the reader skips the information, they'll still succeed.\n- Interrupting the reader at this point is not an obstacle to the reader. For example, your *note* isn't suggesting an alternative that leads the reader down a different path.\n- The information is not part of the flow of what you're writing---it's not just a continuation, a result, or a pointer to additional information.\n\nWhen not to use a *note* notice type\n------------------------------------\n\n- Don't use *notes* for [cross-references](https://developers.google.com/style/cross-references).\n- Don't use *notes* to tell the reader about prerequisites or about steps they should have taken earlier. Information like this should precede the step.\n- Don't make a full procedural step into a *note*.\n- Don't use *notes* to provide information that's necessary for the reader to succeed.\n- Don't use *notes* for information that's in flow with the preceding text. For example, don't use a *note* to state expected results or to include information that simply describes what precedes.\n\nExamples\n--------\n\nUse whatever visual presentation for notices is standard for your site.\n\nIf you're writing in HTML and your site doesn't specify what HTML to use for\nnotices, we recommend using HTML code similar to the following example: \n\n```\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e All VPC networks include firewall\nrules.\u003c/aside\u003e\n```\n| **Note**: All VPC networks include firewall rules.\n| **Caution**: We don't recommend using a subnet that's part of a dynamic route.\n| **Warning**: Do not manually edit or delete generated table entries.\n| **Success**: You've successfully created a Compute Engine instance."]]