projectdoc Toolbox

The tenth chapter of the arc42 Template that lists scenarios to systematically evaluate the architecture against the quality requirements.

ID
swad-section
Docsubtype
swad-section-quality-scenarios
Suite
Parent
Categories
Tags

Summarizes all relevant scenarios to systematically evaluate the architecture against the quality requirements.

This is the tenth chapter of the arc42 Template.

Properties

The document type swad-section 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.

Docsubtype

The subtype of the document type identifies the document instance within its swad-section doctype.

Sections

Description

Provide an overview over the information on this document. Readers may decide on this description if the document contains relevant information to them.

Summary

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

Quality Tree

The quality tree (as defined in ATAM - Architecture Tradeoff Analysis Method) with quality/evaluation scenarios as leafs.

More help to document quality goals in this overview is found on docs.arc42.org.

Using projectdoc

 

You may build the quality tree using Quality Target or Quality documents. For the leaves consider to use Quality Scenarios.

Use the Transclude Documents Macro to transclude from these documents according to the information needs of your stakeholders.

Listing of Scenarios

You may provide an alternative view on the scenarios here.

 Expand for detailed information from https://github.com/arc42

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.

References

The text in the expand boxes is transcluded from the arc42 GitHub project where the arc42 Template is maintained by the original authors and supporters.

arc42 is owned by Dr. Peter Hruschka & Dr. Gernot Starke.