Document application policy

Document application policy

Benefits

Description

Document, document, document. All of the cool new policy options you’ve provided are no use if no one knows about them!

Document all of your program’s uses of policy, both in the User Manual and in online Help. It’s important that you let users know that policy can affect the operation of their application. For options that can be enabled or disabled via policy, advise users of this possibility and the implications for their use of the program.

This documentation is also important to the system administrators. They need to know how to effectively use the policies you offer to lower their TCO. An important place to document policy, which is often overlooked, is in the .ADM file itself. Each policy provided there can have documentation text associated with it using the EXPLAIN keyword.

See Also

Administrative Template File Format, EXPLAIN