nPlace the note, comment, hint, or tip in its own paragraph following the information it pertains to. Format the note, comment, hint, or tip appropriate to the context—numbered list, table, body text, and so on (Figure 4.x).Notes, comments, hints, and tips present information subordinate to the rest of the information in the topic. They are formatted for less visual emphasis within the topic. Whether you use a note, comment, hint, or tip depends on the type of information given.
Notes contain neutral or positive information that emphasizes or supplements important points. Notes can apply to a single paragraph or a whole topic. Comments contain supplemental information. Hints and Tips suggest alternative methods that may not be obvious, and Help users understand the benefits and capabilities of the product. Hints and Tips are not essential to the basic understanding of the text.
nPlace the note, comment, hint, or tip in its own paragraph following the information it pertains to. Format the note, comment, hint, or tip appropriate to the context—numbered list, table, body text, and so on (Figure 4.x).
nAvoid using color and bold together for the subheading.
nWhen using plain text for the subheading, add a colon with one space after it.
nWhen using bold, do not add a colon (Tip).
nDo not add a “Comment” subheading to comments.
nUse notes, comments, hints, and tips sparingly so that they retain their effectiveness.