projectdoc Toolbox

Technical Debts track issues to be paid back.

Description

Document technical debts you have identified. Provide information about the problem and how it can be solved. This information will help you to decide whether to continue paying the interest rate of the debt, paying back the debt or convert the debt.

Properties

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

 

Technical debt is misspelled as technical-dept in versions prior to 1.13.

Type

Specify the type of the technical debt for categorization and selection.

Quality

Describe the qualitative reason for the technical debt.

You may choose to select the quality with the Technical Debt Quality Macro.

Severity

Specify the technical debt's severity of the impact on the project.

You may choose to select the severity with the Severity Macro.

Complexity

Specify the complexity to pay back the debt.

You may choose to select the complexity with the Complexity Macro.

Driver

Add the names of the stakeholder that work on the design of paying back or lessen the amount of the debt.

Deadline

Log the date the technical debt should be paid back.

Status

Define the status of the technical debt.

Reference

Add references to information on external systems here.

Sections

Impact

Document the impact the technical debt will have on the project. Describe this impact from the business' perspective.

Description

Describe the content of this document so that readers are able to decide whether to read further or not.

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.

Resolution

Show how the technical debt could be resolved or how the interest rate could be reduced.

Subordinate Technical Depts

Split larger debts into separate 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

Technical Debt Type
Technical Debts are grouped by the area they address.