7.2 Work with Objects to Be Documented
When you select the option Work with System Documentation option from the Main System Menu, the first screen presented looks something like this:
|
DC@P840101 Work with Documents
Type options and press Enter ..... 2=Review/Change definition 4=Delete 5=Review/Change Selected Objects 7=Produce Document 17=Last Action Details
Opt Document Name Description __ DOCPSLSYS Document describing the Personnel System __ DOC0000001 Technical Document only __ DOC0000002 Document all panel layouts for Personnel
F1=Help F3=Exit F6=Create F12=Cancel F14=Msgs
|
Working from the "Work With Documents" screen you can, by entering one of these options beside a list entry, elect to:
- 2=Review/Change Definition: indicates that the definition of a document is to be reviewed or changed.
When option 2 for review/change is used, a screen showing the detailed definition of the document will be displayed. This screen is described in more detail later.
- 4=Delete Document: deletes an existing document definition.
A confirmation of delete screen will be displayed. Then the above screen will be re-displayed with the deleted document omitted.
- 5=Review/Change Selected Objects: indicates that the list of objects to be documented is to be reviewed and possibly altered. When the REVIEW option is used a menu headed "Review/Change Selected Objects" will be displayed.
By working from this menu it is possible to review and alter the objects that are included for documentation. This menu is described in more detail later.
- 7=Produce Document: indicates that you wish to generate a document for all the objects nominated in the list. The generated document can either be a spooled file or copied to a PC document.
- 17=Last Action Details: indicates that you wish to review the last action details recorded for the document.
Enter this option against any existing document shown on the display. An additional screen will appear showing the last action details. This screen is described in detail previously.
- Create: Use the ADD function key to indicate that a new document is to be defined. Once this has been done a screen will be presented that allows specification of the details of the new document. When all the new document details are valid, the document definition will be created. Next a menu headed "Review/Change Selected Objects" will be displayed.
By working from this menu it is possible to review and alter the objects that are included for documentation. This menu is described in more detail later.