projectdoc Toolbox

These are the generic working horses that are used whenever no specific doctype matches the intention of the author.

Parent
Audience
Level of Experience
Iteration
Filled
Type

Description

This introduces the central doctypes for authors to write documentation. They are used, if no specific doctype is more appropriate for the purpose of the information.

Doctypes

List of document types to define categories valid for all document types.

#NameShort Description
1Association
Associates two documents.
2Profile
Profiles provide views on documents via delegation.
3Resource
Resources are books, webpages, videocasts relevant for the project. Add important information to your project about resources that lie outside the control of your team.
4Section
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.
5Step
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.
6Topic
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.