Create documentation for an application
In this topic, you learn how to add and create documentation for an application.
Prerequisites
-
You have created an application with the App Designer.
Procedure
-
In the Cockpit, select the Documentation tool.
Result: A table of all documentation artifacts for applications in the system is shown.
-
Select Create.
Result: The Create Documentation dialog opens.
-
In Application, select the application that you want to write documentation for from the Application dialog.
-
Select Create.
Result: You start in the General tab of the documentation artifact for the application.
-
In Package, assign a development package of artifacts to the documentation artifact.
-
Go to the Content tab.
-
Select + (Add) in the documentation overview pane to add new documentation for your complete application or context help for one element in your application.
-
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.
-
In Icon, you can select an icon from the Icon Explorer dialog that serves as the documentation icon for the documentation artifact.
-
In the Dialog section, you can adjust the size of the dialog in which the documentation appears.
-
In the documentation editing pane, write and edit the text of your documentation.
-
Select Save.