projectdoc Toolbox

Doctypes and macros applied for any team collaboration project in a wiki.

Iteration
Production

Documents

The following documents are tagged with this tag.

NameShort DescriptionDoctype
Core Doctypes
Provides a basic set of doctypes to create agile documentation.
topic
Association
Associates two documents.
doctype
Association Type
Categorize associations by a type.
doctype
Category
Categories allow to set document instance of different doctypes in a hierarchy.
doctype
Category Type
Categorize categories by a type.
doctype
Charter
Describes an information need and use this description as a basis to create and maintain a document.
doctype
Charter Type
Categorize charters by a type.
doctype
Excerpt
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.
doctype
Excerpt Type
Categorize excerpts by a type.
doctype
Experience Level
Defines the context through which readers acquire skills. The level sets the expectation on the author's techniques to teach.
doctype
Experience Level Type
Categorize experience levels by a type.
doctype
FAQ
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process.
doctype
FAQ Type
Categorize FAQs by a type.
doctype
Generic
Generic Documents provide information where no other doctype matches.
doctype
Generic Type
Categorize generic documents by a type.
doctype
Glossary Item
Glossary items are part of the domain glossary for the project. Glossaries support the team to use terms of the domain consistently in conversations and documentation.
doctype
Glossary Item Type
Categorize glossary items by a type.
doctype
Media Type
Resources are identified by their media type. This may be the MIME type, but also a human readable string, that identifies the syntactic format.
doctype
Media Type Type
Categorize media types by their type.
doctype

Metadata documents provide tables of simple key/value pairs. This information can be used as an aspect or as additional space properties to be available for reference on your wiki.

doctype
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
Module Type
Categorization of document modules for single sourcing.
doctype
Organization
Information about organizations that take a part in the project. You may collect common information here for all persons that belong to an organization, such as address or homepage.
doctype
Organization Type
Categorize organizations by a type.
doctype
Person
Provides information about a person. This includes contact information (important if the person is relevant for the team) or information about the competences (if the person is an author about a topic relevant for the project).
doctype
Person Type
Categorize persons by a type.
doctype
Profile
Profiles provide views on documents via delegation.
doctype
Profile Type
Categorize profiles by a type.
doctype
Quote
Quotes relevant for the project. Allows to store the content and metadata to the quote.
doctype
Quote Type
Categorize quotes by a type.
doctype
Relation
Organizes glossary items.
doctype
Relation Type
Categorize relations by a type.
doctype
Resource
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.
doctype
Resource Type
Resources are identified by their type. This is not the MIME type, but human readable string, that identifies the semantic, rather than the syntactic format.
doctype
Role
Defines a role with its responsibilities, tasks and requirements. Roles are incorporated by stakeholders who take interest in the project. The are also used to define the audience for documents.
doctype
Role Type
Categorize roles by a type.
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
Section Type
Categorize sections by a type.
doctype
Space Index
Compile other documents, yet space indices are themselves projectdoc documents. So they can be tagged and grouped.
doctype
Space Index Type
Categorize space indexes by a type.
doctype
Stakeholder
A party that takes interest in a project. The stakeholder is either a real person, an organization or group, or represents a class of individuals, groups or organizations.
doctype
Stakeholder Type
Categorize stakeholders by a type.
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
Step Type
Categorize steps by a type.
doctype
Subject
Subject documents allow to set document instance of different doctypes in a common context.
doctype
Subject Type
Categorize subjects by a type.
doctype
Tag
Document the semantics of a tag. May also be used to document Confluence labels.
doctype
Tag Type
Categorize tags by a type.
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
Topic Type
A topic type is a semantic type of the topic. It helps to set the expectations of potential readers.
doctype
Tour
Guided tours through existing information. This allows to aggregate topics for a given question or audience, thus providing a view on a topic.
doctype
Version
Document a version of a product or service.
doctype
Version Type
Categorize versions by a type.
doctype