projectdoc Toolbox

A list of doctypes that have a specific purpose. The core doctypes are none-the-less quite generic so that they can be used in almost any project.

Audience
Level of Experience
Type

Specific doctypes of the core extension add-on are quite generic in the sense that they are probably useful in any project. But they are specific in respect to their intention. While generic doctypes like Topic may hold information of any kind, doctypes like Role or Person have a specific purpose.

People Doctypes

List of document types that are concerned with referencing information about people and their roles that are relevant for the project.

#NameShort Description
1Organization
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.
2Person
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).
3Role
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.
4Stakeholder
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.

Typical Project Doctypes

List of document types that are usually used in projects as specific purpose types.

#NameShort Description
1FAQ
FAQs help to record an answer to a frequently asked question concerning the project, the product, the system or the process.
2Glossary 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.

External Resources

List of references to external information. This allows to link to an external resource that is not in control of the team and add information that is relevant to the project.

#NameShort Description
1Organization
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.
2Person
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).
3Quote
Quotes relevant for the project. Allows to store the content and metadata to the quote.
4Resource
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.

 

If you want to reference resources, use the following macros:

Cite Macro
Renders a cite to a resource document.
External Quote Macro
Renders a quote to an external resource with author and source.
Quote Macro
Renders a quote from a resource with author and source.

For more information on using the Resource and related doctypes, please refer to Collecting Information.