Document your app for your users and customers.
- Categories
- / Doctype / API
- ID
app- Suite
- Since
- 1.0
Apps extend the functionality of the product platform. While apps should not need much documentation to make it easy for its users to take advantage, the domain is not always easy and self-explanatory. For these application domains additional documentation for users and customers is very useful.
Properties
The document type app provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
Type
Declare the type of this app. This information is used for categorization and allows to collect all apps on the referenced type page.
Sections
Description
Give a short overview over what the app is about (very brief) and what information this document provides.
Summary
Provide a concise description of the app for executives that need to decide whether to employ your app or not. Keep it very brief since readers of this summary need to understand quickly the usefulness of the app.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
The text of notes sections is also indexed.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
For further information please refer to References and Resources.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
For further information please refer to References and Resources.