Document the usage of a doctype for your users.
Doctypes define types of documents with properties and sections. They also often provide a home page to store instances of its type. The central element of a doctype is the blueprint.
Properties
The document type doctype provides the following properties:
ID
Specify the unique doctype identifier.
Type
Declare the type of this doctype. This information is used for categorization and allows to collect all doctypes on the referenced type page.
Suite
Specify the suite of tools the doctype belongs to.
Blueprint
Provide a reference to the Confluence page blueprint the doctype uses.
Sections
Description
Give a short overview over what the doctype is about (very brief) and what information this document provides.
Details
Provide detailed information on using this doctype for documentation. This allows to give background information on concepts and best practices.
Subordinate Doctype
If a doctype is divided in different variants or composed of other doctypes, mention them here.
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.
