A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
Grouping topics by type, the topic type also helps readers to set their expectations of the topic document's content.
Typical topic types are:
Properties
The document type topic type provides the following properties:
Sections
Description
A detailed description of the topic type.
This helps authors to select the appropriate type for their topics.
Subordinate Types
Group topic types by putting them in a hierarchy.
Topics of this Type
An overview over topics of this type.
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.
Resources
- Topic Types - examples of document instances for use in your project.