Document conventions
Style Description Example
Danger
A danger notice indicates a situation
that will cause major system changes,
faults, physical injuries, and other
adverse results.
Danger:
Resetting will result in the loss of
user configuration data.
Warning
A warning notice indicates a situation
that may cause major system changes,
faults, physical injuries, and other
adverse results.
Warning:
Restarting will cause business
interruption. About 10 minutes are
required to restart an instance.
Notice
A caution notice indicates warning
information, supplementary
instructions, and other content that
the user must understand.
Notice:
If the weight is set to 0, the server
no longer receives new requests.
Note
A note indicates supplemental
instructions, best practices, tips, and
other content.
Note:
You can use Ctrl + A to select all
files.
>
Closing angle brackets are used to
indicate a multi-level menu cascade.
Click Settings> Network> Set network
type.
Bold
Bold formatting is used for buttons ,
menus, page names, and other UI
elements.
Click OK.
Courier font Courier font is used for commands
Run the cd /d C:/window command to
enter the Windows system folder.
Italic
Italic formatting is used for
parameters and variables.
bae log list --instanceid
Instance_ID
[] or [a|b]
This format is used for an optional
value, where only one item can be
selected.
ipconfig [-all|-t]
{} or {a|b}
This format is used for a required
value, where only one item can be
selected.
switch {active|stand}
BBAAD9C20180234D78A0072836F0BF10A2B9B20710143BA0A0D9833BB1482BF11B48B038B158FB0322B926089846D2EB4CE921DAB1D0CB211BBFC2E1763E36DC241430AD4E2CC9C7F416253768A74D947737E17A71A4753ED81B919C6FB2DC58D8A6259B3E3