projectdoc Toolbox

Phase concerned with the design of a solution.

Name
/ Process / Design
Parent

Documents

The following documents are associated with this category.

NameShort DescriptionDoctype
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.
doctype
Architecture Aspect
Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.
doctype
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.
doctype
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.
doctype
Blackbox
Describe as a Blackbox the elements of a view where only the externally visible properties are relevant.
doctype
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.
doctype
Component Type
Component types categorize components.
doctype
Environment
Document logical or physical groups of nodes.
doctype
Interface
Interfaces document how elements of the system communicate with elements of this and other systems.
doctype
Node
Nodes are part of environments where artifacts are deployed to.
doctype
Use Case
Defines a use case of the product.
doctype
Use Case Type
Use case types categorize use cases.
doctype
View
Different views on the product help to document the system and its architecture. Typical views are building block, runtime, or deployment.
doctype
Whitebox
Describe as a Whitebox the elements of a view where only the relations of internal elements are relevant.
doctype