projectdoc Toolbox

Qualities describe desired aspects of the product.

Description

Qualities describe desired aspects of your product. Making them visible to everyone on your team helps to stay focused and share a collective vision of your product.

Properties

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

Target Group

List quality targets to associate with this quality.

Context

Specify the context the target group experiences the quality (or the lack of this quality).

Sections

Description

Describe the quality, usually in a project-independent manner.

Influencing Factors

List the factors that have an influence on this quality.

You may mention other qualities here or add additional influences that are specific for your domain.

Topics

Provide information and concepts organized into topics that are relevant to understand and handle this quality.

Aspects

List specializations of this quality. Attach these descriptions as children to this document.

Generic Scenarios

List generic scenarios of this quality.

Example Scenarios

List examples of for the generic scenarios of this quality.

Production Scenarios

List production scenarios for the developed system.

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.