Use the note-avaya tag in our authoring environment for general notes. You can use a general note sparingly to call attention to supplemental information, such as information that does not fit well into the surrounding text or that only applies in certain circumstances.
You do not want readers to ignore a note. However, only use a general note when the situation you are describing does not have serious consequences. Specifically, do not use notes to call attention to situations that can result in data loss, damage to software or hardware, or harm to personnel. When a situation is serious, use the appropriate admonishment.
Example |
As an administrator, you can configure message retention settings. Messages are automatically deleted after the set time.
Note:
If you have the free basic license, messages are retained for a maximum of 30 days.
|
Never include two or more paragraphs formatted as notes without intervening text. You can include lists within notes.