Central Topic Types

Defines the topic types used in this project.

For some topic types there are specific doctypes. So there is no topic type instance defined for:

  • Procedure: Checklist (doctype) or Howto (topic type)
  • Process: View (doctype)
  • Definition List: Glossary Item (doctype)

FAQ (doctype) may also provide a basic structure for Trouble Shooting.

The central topic types of the project.

NameShort DescriptionTags
Article
An in-depth publication of information on a given topic.
Concept
Howto
A short, straight-to-the-point set of instructions to accomplish a specific task.
Task
Reference
Provides reference information for users of the projectdoc Toolbox.
Reference
Report
A view on a given topic at an instance of time. May be relevant for management, compliance or documentation for later reference.
Aggregate
Shot
A short information with reference(s) to further information. A shot is a tip or trick, a remarkable observation to be shared with others.
Concept
Tip
A short information used for tips of the day. It supports users to investigate unused features of a product.
Concept
Tour
Provides a tour through a collection of articles with a given question and specific audience.
Aggregate
Trouble Shooting
Description of a problem and a solution or workaround.
Aggregate
Tutorial
A problem-centric introduction to a given problem. It is a learning tool to transfer knowledge. Usually provides references for further information to investigate related topics in greater detail.
Concept
Volume
A comprehensive, often authoritative collection of information.
Aggregate



Related Information

Related information in your wiki: