7. Documentor

The Documentor facility in LANSA is provided to enable you to generate technical and user documentation for LANSA based applications.

To document a LANSA application, you first prepare a list of the objects and associated subjects to be documented and then specify what is to happen to the generated documentation.

Every document you create has a name and remains in the LANSA system until you delete it.

Objects (e.g. fields, files, processes) which are referenced in a document will be automatically removed from the document if the object is deleted from your LANSA system.

The steps involved in working with documents can be visualized like this:



    1. Select the option to "Work            |          |

       with System Documentation"            |   MAIN   |

       from the Main System Menu.            |  SYSTEM  |

                                             |   MENU   |





    2. From the list of "documents"          |          |

       displayed elect to ....               |   WORK   |

                                             |   WITH   |

       - Create a new document               | DOCUMENTS|

       - Review/change document definition   |__________|

       - Review/change selected objects                      

       - Delete a document

       - Produce a document