Document the usage of a document property for your users.
Properties hold metadata of a document. Properties used by multiple doctypes are stored in the document property doctype homepage. Properties used exclusively by one type of document are associated to the doctype document as a child document.
Properties
The document type document-property provides the following properties:
Type
Declare the type of this document property. This information is used for categorization and allows to collect all document properties on the referenced type page.
Sections
Description
Provide a description what the document property is about. Limit this description to one to three paragraphs.
Details
Provide further information about the property and maybe provide usage examples.
Subordinate Document Properties
Typically not needed, but provided since every doctype allows to reference child documents.
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.
