Organization

Last Updated : Oct 20, 2021 |

To ensure readability and completeness, the information for each feature is categorized into the following topics:

  • Summary

  • Detailed description

  • Administering

  • End-user procedures

  • Reports

  • Considerations

  • Interactions

  • Troubleshooting

Summary

The Summary section provides a brief description of the feature. For simple features, the Summary might be only one sentence. For more complex features, the Summary might be one or two paragraphs.

Detailed description

The Detailed Description section provides detailed information about the feature. Some features have more than one function, called capabilities.

Administering

The Administering section provides the information that you need to administer and implement the feature. This section includes the following information:

  • Any prerequisite that you must complete before you administer the feature

  • The screens that you use to administer the feature

  • Complete administration procedures for the feature

End-user procedures

The End-user procedures section describes any procedures that might exist for a user to activate, deactivate, or otherwise modify administration of the feature, or a capability of the feature.

If a feature does not have end-user procedures, the feature description does not contain this section.

Reports

The Reports section lists the reports that provide information about the feature. If a feature does not have any reports, the feature description does not contain this section.

Considerations

The Considerations section provides any useful miscellaneous information about the operation of the feature. If a feature does not have considerations, the feature description does not contain this section.

Interactions

The Interactions section describes how the feature interacts with other features. For example, certain features must always be used in conjunction with other features. Some features cannot coexist with other features. In some cases, the normal operation of a certain feature modifies the normal operation of another feature. Some features also enhance each other, and when combined, provide improved service to the user. The features are listed in alphabetical order.

Troubleshooting

The Troubleshooting section provides a table that lists the following information:

  • Known or common problems that users might experience with the operation of the feature

  • Possible causes of the problems

  • Actions that an administrator can take to solve the problems

If a feature does not have troubleshooting tips, the feature description does not contain this section.