projectdoc Toolbox

Tools (especially doctypes) that support the modularization of documentation.

Documents

The following documents are tagged with this tag.

NameShort DescriptionDoctype
Association
Associates two documents.
doctype
Charter
Describes an information need and use this description as a basis to create and maintain a document.
doctype
Module
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.
doctype
Profile
Profiles provide views on documents via delegation.
doctype
Section
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.
doctype
Step
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.
doctype
Topic
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.
doctype