Documentation for the users of the project's product.

Doctypes of this Type

Name Short Description
Associates two documents.
Describe the codes that are part of the product's API.
Excerpts are abstracts of information found in a resource, such as a book. If you want to go into more detail for a given resource, there may be multiple excerpts as subpages of the resource document.
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process.
Documents a feature of the product. The top features define the main aspects of the product.
Generic Documents provide information where no other doctype matches.
A documentation module is a fragment which is usually transcluded by other documents. The lifetime of a module document is independent of the lifetimes of the documents that reference it.
Patterns provide solutions for problems in a given context. Patterns are usefull in multiple areas such as design, architecture, documentation, or process.
Profiles provide views on documents via delegation.
Properties are part of the configuration options of a system.
Sections of a document are typically part of a document. But the size of sections may vary. To support a team to write collaboratively on the documentation, a larger document may be subdivided into external section documents.
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.
Describes a single step of an activity. A step is a generic document that is associated with a document that describes a process. It may be a test log or a howto.
A description of a given topic. A topic may describing or explaining a concept, a task to accomplish or a reference. There are a couple of topic types that set the expectations for the reader. Instances of the topic doctype usually have independent lifetimes from any referencing documents.
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.