- Created by Robert Reiner, last modified on 14. Nov 2018
projectdoc Toolbox
Use case types categorize use cases.
- ID
use-case-type- Suite
- Parent
- Documentation Type
- Categories
- Tags
Use cases are organized by their types. Instances of the document type define those types.
Properties
The document type use case 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
Related Indices
Lists space index documents related to this type.
Every space index that references this type by the property Use Case 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.
Use cases of this Type
An overview over use cases 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 to document system environments.
- Architecture Alternative
- Document a possible option for an architecture decision. Choose this document type to describe the alternative for a decision in more detail. This is typically a subpage of an architecture decision document.
- Architecture Aspect
- Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
- Architecture Decision
- Document a architecture decision for an option. This is useful to state the reasons and the options that have been evaluated. Later other team members will have it easier to understand the decision.
- Artifact
- Document requirements you impose on artifacts. Artifacts are created by processes defined and used by the team. This includes assemblies created by the build process, source code artifacts or reports.
- Blackbox
- Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
- Component
- Components are part of a view on a system. A component may refer to a enclosed element or to a complete system of its own.
- Component Type
- Component types categorize components.
- Environment
- Document logical or physical groups of nodes.
- Interface
- Interfaces document how elements of the system communicate with elements of this and other systems.
- Node
- Nodes are part of environments where artifacts are deployed to.
- Use Case
- Defines a use case of the product.
- View
- Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
- Whitebox
- Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
