Documentation Utilities › Introduction › Documentation

Documentation

The Toolkit Documentation Aids help to improve your documentation in several important ways:

• By providing documentation utilities that will assemble up-to-date descriptions of your actual systems, collated with the relevant descriptive text.
• By providing computer-generated cross-references to index your documentation.
• By providing a method of extracting selected comments from program source into a higher level summary.
• By providing a method of storing information about additional object attributes in the source. For details of this facility, see the section Compile Preprocessor in the chapter "Programmer Aids".
• By providing utilities to present on-line Help text. For further details, see the section on help text in the "User Access Aids" chapter.
• By providing good ‘hard copy’ for all of the Toolkit utilities: for example, menu, panel and report designs, and object, database file and member lists.
• By providing standards that can be used to streamline and structure documentation. The importance of this last point should not be underestimated: a good standard structure removes the need for repetition of information already given by the context.

Your company name can be made to appear on all documentation.