Create documentation for an application

In this topic, you learn how to add and create documentation for an application.

Prerequisites

Procedure

  1. In the Cockpit, select the Documentation tool.

    Result: A table of all documentation artifacts for applications in the system is shown.

  2. Select Create.

    Result: The Create Documentation dialog opens.

  3. In Application, select the application that you want to write documentation for from the Application dialog.

  4. Select Create.

    Result: You start in the General tab of the documentation artifact for the application.

  5. In Package, assign a development package of artifacts to the documentation artifact.

  6. Go to the Content tab.

  7. Select + (Add) in the documentation overview pane to add new documentation for your complete application or context help for one element in your application.

  8. In the Details section, enter the following fields:

    Title

    Enter a meaningful title for the documentation.

    Introduction

    Enter a meaningful introduction text for the documentation.

    Context Aware Help

    You can decide if the documentation is only visible for one part of your application, by connecting a documentation marker to a UI object within the structure of the application. Select the UI object that you want to enable the context-aware help for. Only UI objects marked in green can be assigned context-aware help.

    You can bind a global i18n model for the Title and Introduction fields of the documentation by selecting the binding icon.

  9. In Icon, you can select an icon from the Icon Explorer dialog that serves as the documentation icon for the documentation artifact.

  10. In the Dialog section, you can adjust the size of the dialog in which the documentation appears.

  11. In the documentation editing pane, write and edit the text of your documentation.

    Use the globe icon () to toggle the i18n binding panel to insert global i18n model attributes for localized text to the editing pane of the documentation where you place and focus your cursor.

  12. Select Save.

Results

  • You have created and added documentation for your application or parts of your application.

Related topics