System messages
From TechWriter Wiki
Specify messages exactly as they appear on the screen (or report)
Always display messages in a separate paragraph; never in-line.
It is a good idea to render system messages in a font other than the one in which the standard text is displayed. By convention, Courier New is used (although in modern systems, messages are no longer displayed in a non-proportional font) and bold text.
Variables within a message should be replaced by a meaningful identifier contained in chevrons, and formatted in italic, non-bold.
Examples:
| Incorrect | Correct |
|---|---|
| Result: The message Order XXXXXXXX has been saved is displayed. | Result: The following message is displayed: Order <OrderNum> has been saved |
| Do you want to exit? Unsaved data will be lost. | Do you want to exit? Unsaved data will be lost. |
