Added Message Management for Message Guidance

[hogstrom]

Signed-off-by: Matt Hogstrom matt@hogstrom.org

[nannanli]

Please consider the following edits:

Message Management

A message is any communication that is passed from the application to a user or to another application, including error messages, return codes, and reason codes. A message typically suggests an action, indicates a condition, or informs that an event has occurred. This document describes the message ID, message format and guidelines for Zowe.

Message format

All messages must have the following information:

• Message ID
  Specifies a unique alphanumeric identifier that provides a quick means to distinguish one message from others.
• Message text
  Briefly describes the problem.

Message ID

A message identifier (message ID) is a unique group of alphanumeric characters that identifies a message. The message ID typically has these parts:

• Registered project identifier
• The product component (optional)
• Message number
• Message type

In Zowe, message ID uses the following format:
ZWEcnnnnt

Where,

• ZWE
  Specifies the registered project identifier. Zowe messages use the static identifier ZWE.
• c
  A variable that specifies one of the following registered Zowe components. Components need the ZLC to approve the use of the component to ensure consistency across all of the projects.
  • A - API Mediation Layer
  • C - Zowe CLI
  • D - Zowe Desktop
  • E - Zowe Explorer
  • S - Zowe System Services
• nnnn
  A variable that specifies the message number which ranges from 0001 to 9999. Projects may choose to use the first digit to divide the number space.
• t
  A variable that specifies the message type. It can be one of the following values:
  • I - Informational
  • E - Eventful action or Error
  • A - Action
  • W - Warning
  • S - Severe error

Messages should be sent to the Zowe doc team and follow the general IBM format as described in Messages and Codes.

Examples

• ZWEA002I API Mediation Layer initialization complete
• ZWED002E Cannot load plug-in a plugin that should have been loaded

[fbeyl]

Maybe add job and syslog to the text.
A message is any communication that is passed from the application to a user, to another application, to the joblog or to the syslog including error messages, return codes, and reason codes.