Previous Topic: Documenting Commands

Next Topic: Standards For Preparing Text Documentation

Messages

OS/400 messages provide a highly flexible way of providing context-sensitive documentation. Messages should be regarded as an integral part of the application system documentation.

The first level text of diagnostic messages should state what the problem is. The second level text should contain an explanation of the cause of the problem and possible solutions.

For more information on message layout conventions, refer to the section Coding Standards for Messages in the chapter "Coding Standards for Database Files" chapter in this guide.

The CA 2E Document Model Messages (YDOCMDLMSG) command provides a means of producing a message manual for your application.