projectdoc Toolbox

Groups the views at a system.

Grouping views by type, the view type also helps readers to set their expectations of the view document's content.

Properties

The document type view type provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Sections

Description

A more detailed description of the artifact type than already provided in the short description.

This helps authors to select the appropriate type for their views.

Elements

Describe the elements that are part of this view type.

Notation

Explain or reference the notation for diagrams used in the view. Show how the elements listed above will represented in those diagrams.

If a standard is used, simply reference the standard version used.

Example

Maybe an example would speed things up for team members wanting to create a view of this type.

Add one (or more) examples here.

Related Indices

Lists space index documents related to this type.

Every space index that references this type by the property View Type Constraint is listed in this section. This makes it easier for readers to navigate to related information by browsing.

Since 11.1

 

This section is available since version 11.1.

Subordinate Types

List subtypes of this type.

Justification

A new view type should be justified to keep the number of view types small.

Give explanations here why none of the existing types fitted the requirements.

Views of this Type

An overview over views of this type.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.

Related Doctypes

Here is a list of related doctypes that define types for categorization of document instances:

Alternative Type
Group your alternatives by a self-defined type.
App Component Type
Document the purpose and usage of the components of this type.
App Extension Type
Document the purpose and usage of the extension of this type.
App Macro Type
Document the purpose and usage of the macros of this type.
App Parameter Type
Document the purpose and usage of the app parameters of this type.
App Platform Type
Document the purpose and usage of the platforms of this type.
App Service Type
Document the purpose and usage of the app services of this type.
App Tool Type
Document the purpose and usage of the app tools of this type.
App Type
Document the purpose and usage of the apps of this type.
Artifact Type
Artifact types categorize artifacts.
Assumption Type
Assumptions are grouped by their type.
Checklist Type
Categorize checklists by type.
Data Type Type
Data type types categorize data types.
Decision Type
Group your decisions by a self-defined type.
Doctype Type
Document the purpose and usage of the doctypes of this type.
Document Property Type
Document the purpose and usage of the properties of this type.
Document Section
Document the purpose and usage of the sections of this type.
Environment Type
Type of an environment used by the project to deploy the application or the solution.
Minutes Type
Group your minutes by a self-defined type.
Node Type
Node types categorize nodes.
Open Issue Type
Group your open issues by a self-defined type.
Opportunity Type
Opportunities are grouped by their type.
Page Blueprint Type
Document the purpose and usage of the page blueprints of this type.
Pattern Domain
Patterns are divided into different domains to group patterns.
Pattern Type
Categorize patterns by type.
Problem Type
Problems are grouped by their type.
Project Rule Type
Categorize project rules by type.
Release Note Type
Group your release notes by a self-defined type.
Report Type
Group your reports by a self-defined type.
Risk Action Type
Risk actions are grouped by their type.
Risk Phase
Risks are grouped by the phase of their impact on the project.
Risk Probability
Risks are grouped by the probability of having impact on the project.
Risk Severity
Risks are grouped by the severity of their impact on the project.
Risk Target Type
Risk tagets are grouped by their type.
Risk Type
Risks are grouped by their type.
Space Blueprint Type
Document the purpose and usage of the space blueprints of this type.
Space Property Type
Document the purpose and usage of the space properties of this type.
Team Process Type
Categorize team processes by type.
Tool Type
Categorize tools by type.