projectdoc Toolbox

Document an aspect of your architecture. Something orthogonal or cross-functional like logging, exception handling or configurability.

ID
architecture-aspect
Set
Parent
Documentation Type
Categories
Tags

Description

Documents an orthogonal or cross-cutting concern for the architecture of the system. By describing these aspects in their own documents, components applying those concerns may just reference them.

Examples for architecture aspects are:

  • Logging
  • Exception Handling
  • Component Configuration
  • Monitoring

Properties

The document type architecture aspect 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 detailed description of the architecture aspect.

Add any additional sections to this one (if required) to document details on the aspect.

Summary

Provide a summary of the document's structure and key points. This is an informative abstract typically of about 100 to 200 words.

For more information please refer to Summary.

Motivation

Quality Scenarios

Quality scenarios document the important quality aspects of the architecure aspect. Add a reference to a quality scenario document for each important quality of the aspect.

Use Cases

Use cases allow to define how the aspect is used.

Solution

Constraints

List the constraints that limit the solution space for the aspect.

Decisions

The design or implementation of an architecture aspect may be based on some decisions. List those that are important to understand the aspect.

Application

Provide information about how to apply the solution.

Discussion

Discuss open issues and provide an overview over possible next steps.

Subordinate Aspects

Divide a complex aspect into smaller parts.

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

The related doctypes are already mentioned in the sections:

Component

Components usually reference architecture aspects that have an impact on them.