projectdoc Toolbox

Document problems as a means to communicate the details and to use the information for reviews and retrospections.

ID
problem
Suite
Parent
Documentation Type
Since
1.0

Properties

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

Type

Specify the type to organize problems.

Assignee

Specify the stakeholder responsible for tracking this problem.

Recognized on

Log the date the problem has been recognized.

Deadline

Log the date the problem has to be managed that it will not have negative impacts on the project.

Reference

Add references to information on external systems here.

Sections

Description

Describe the problem.

Subordinate Problems

Complex problems may be detailed in separate problem descriptions, which are added as children to this document.

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

Problem Type

The Problem Type Doctype allows to organize risks.