notices

✍️ google-blog-style

Source: https://developers.google.com/style/notices\n\n# Notes, cautions, warnings, and other notices

Stay organized with collections

Save and categorize content based on your preferences.\n\n- Home\n- Products\n- Style\n\n\n## Page Summary\n\n- Notices highlight useful information outside the main text flow, but readers may overlook them.\n- Minimize notice usage, as overuse diminishes their effectiveness and consider alternative ways to convey the information.\n- Choose from four notice types: Note, Caution, Warning, and Success, each serving a distinct purpose.\n- Notes provide relevant but non-critical information, while Cautions advise careful proceeding, and Warnings highlight potential risks or irreversible actions.\n- Success notices indicate positive outcomes but are restricted to interactive content.\n\nNotices highlight useful information outside the main text flow, but readers may overlook them.\n\nMinimize notice usage, as overuse diminishes their effectiveness and consider alternative ways to convey the information.\n\nChoose from four notice types: Note, Caution, Warning, and Success, each serving a distinct purpose.\n\nNotes provide relevant but non-critical information, while Cautions advise careful proceeding, and Warnings highlight potential risks or irreversible actions.\n\nSuccess notices indicate positive outcomes but are restricted to interactive content.\n\nTo 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.\n\nDon'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.\n\nWhere 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.\n\n\n## Pick a notice type\n\nThe following is a list of commonly used notices.\n\n\n## When to use a note notice type\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\n\n## When not to use a note notice type\n\n- Don't use notes for 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\n\n## Examples\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

notices, we recommend using HTML code similar to the following example:\n\n```\n<aside class="note"><b>Note:</b> All VPC networks include firewall

rules.</aside>\n```\n