Documentation
This section describes how to create documentation for an application and provide it to an app user.
Last updated
This section describes how to create documentation for an application and provide it to an app user.
Last updated
Sometimes it is necessary or desirable to provide a description of how an application works and how to use it. The user of this app can then read this published text at any time.
In addition, it is possible to reorder the pages by drag and drop:
Pages can be reordered into the root and can be reordered into other parents (as a child). If the page has children, when the page is reordered, then all children are reordered with it.
To edit a page, select a page from the overview. The Documentation Designer will open. The previously created content appears in three different views.
Content views sections:
Editors (1) - WYSIWYG HTML editor with toolbox and markdown editor
Preview (2) - view that the app user also sees
Contents (3) - table of contents of this page
Two editors are offered for editing the content. The first one is the WYSIWYG editor (tab Easy Editor), with which the direct editing of the text formatting is possible. With the help of the toolbox you can easily select the styles. You will see the changes immediately in the preview. In addition, images can be added to the page (toolbox: Insert->Image).
As an alternative there is a Raw Editor. This is located in the second tab in the editor section (1). With this editor Markdown text can be entered or copied. Of course, the changes are also changed immediately in the preview.
Attachments can be added to each page. For this purpose, there is an area at the bottom of the editor to fold up. There appears an upload button with which you can attach all possible files. See next picture under # 1 (Documentation Designer).
To save the changes made to the page press the button on the right in the footer (4). You can also delete the page. To do that use the 'Delete Page' button in the footer on the left (2).
After the page is saved, it is not yet available to the user of this workspace. He cannot see it. To do this, the page must first be published. To see immediately if the edited page is published, there is an indicator in the footer (3). If not published is displayed there, the page is not yet published. Otherwise, the date when the page was last published is there.
To publish, the action Publish Page must be selected in the context menu at the top right.
After the content is published, a user of this workspace (view mode) can also read the created documentation. The standard app Help is provided for this purpose. After opening this app, all created documents of this workspace will be displayed. This means that the documents from all workspace apps are listed one below the other in the Help app.
Navigate to your Workspace > Apps and click on the gear icon to activate the configuration mode of your applications. Next, click on the gear icon of the application you wish to configure. In the App section you click on Documentation to access the documentation management window.
The documentation management window gives you a good overview of the pages already created and the structure of this document. You can filter, expand or collapse all existing pages, use the Import/Export buttons to download a CSV file and upload it again after editing and add new pages.
