Documenting Commands

If commands are used to document a system, they should be documented in two separate ways:

With command diagrams for all commands, arranged in alphabetical order of command name. Each diagram should contain the following sections:
- Function: A synopsis of the purpose of the command.
- Diagram: A command diagram prepared according to the OS/400 conventions.
- Parameters: A description of each parameter specifying the allowed values, including any defaults and special values.
- Notes: Notes about any special considerations for using the command, and information about any prerequisite or subsequent processing steps.
- Example: An instance of using the command.
With a Concepts Guide that discusses each area of the application system and names the individual commands that are relevant to that area. The concepts section provides an alternative access path for understanding the purpose of individual commands in terms of the whole application system.

For more information on an example of documenting commands, refer to the appendix, "Programming and Coding Examples," in this guide.

For good models, refer to the OS/400 CL Reference Guide (command diagrams) and the OS/400 Programmer’s Guide (concepts).