Creating and Editing a Worklist

Procedure

Using a selection list for maintaining documentation enables you to:

  • Work on a larger set of documents of various document classes in context. You can define that set by specifying various selection criteria.

  • Maintain short texts for the objects in your work list by double-clicking on the short text displayed in the work list overview.

  • Use the following print output options:

    • Print a list of the documents or objects selected with administrative information

    • Formatted documentation texts with INCLUDEs

    • Documentation texts in editor format including expanded links

You can use the following selection criteria when creating a worklist:

  • Processing status

    • Objects not to be documented

    • Undocumented objects

    • Raw version documents

    • Documents in final version

    • Active documents

  • Environment for worklist

    • Development class

    • Transaction

    • Program

    • Table

  • Document class

    You can choose document classes form the list available for end user documentation.

Creating a Worklist

  1. In the initial screen of the documentation maintenance transaction, select the menu function Start of the navigation pathUtilities Next navigation step WorklistEnd of the navigation path. You reach the Documentation: Worklist screen.

  2. Select one or more processing status (the processing status Objects not to be documented can only be selected on its own).

  3. Under Environment for Worklist select an environment (development class, transaction, ...) and choose Continue. A dialog box appears in which you can enter the name of the selected environment.

  4. Enter one or more names from the selected environment category (for example, development classes) and choose Continue. Select the document classes you require on the next dialog box.

  5. Select the document classes you require and then Continue. The required worklist is generated.

  6. Save the work list you have generated with menu function Start of the navigation pathWorklist Next navigation step SaveEnd of the navigation path.

Using an Existing Worklist

  1. In the initial screen of the documentation maintenance transaction, select the menu function Start of the navigation pathUtilities Next navigation step WorklistEnd of the navigation path. You reach the Documentation: Worklist screen.

  2. Select one or more processing status (the processing status Objects not to be documented can only be selected on its own).

  3. Under Environment for Worklist select the Existing Worklist option and choose Continue. The system displays the Edit Worklist dialog box.

  4. Specify the name of the environment (package, program, and so on) and select Continue. Select the document classes you require in the next dialog box. You can select a worklist for editing or deletion from list.

Updating an Existing Worklist

A saved worklist includes the total of all documents and objects that correspond to the editing status, environment, and document class at the time the selection criteria were saved. Also the short texts displayed in the worklist represent the status at the time of saving. The worklist needs to be updated to include system objects that came later and to take any other changes to short texts into consideration:

  1. Select a worklist.

  2. Choose Update.

  3. Save the updated worklist.