Document your extension for your users and customers.
Like Apps extend the functionality of the product platform, extensions extend the functionality of an app. Still keep in mind that users are not used to read documentation. But for complex domains supporting information may be welcomed.
Properties
The document type app-extension provides the following properties:
Type
Declare the type of this extension. This information is used for categorization and allows to collect all extensions on the referenced type page.
App
Reference to the app this is an extension for.
Version
Provide the current version of the extension this documentation is based on.
Status
Provide the status describing the availability of this extension.
Logo
Provide a logo for this extension.
Marketplace URL
Provide the URL to the marketplace this extension is available for customers.
Sections
Description
Give a short overview over what the extension is about (very brief) and what information this document provides.
Summary
Provide a concise description of the extension for executives that need to decide whether to employ your extension or not. Keep it very brief since readers of this summary need to understand quickly the usefulness of the extension.
Subordinate App Extensions
Provide information of subordinate app extensions.
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.
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.
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.
