Carregando...
Logo isTDMFramework

TD Documentation

It provides guidelines to register relevant information about TD, which contributes to increasing the communication on existing TD with all stakeholders and making explicit such debt characteristics.
Some terms are highlighted in italics. You can access definitions for these terms by clicking on them.

Activity DOC_1: Define and use specific SE technologies to document TD

Project members can define and adopt particular SE technologies to support the documentation of TD items.

Task DOC_T1.

Identify and define SE technologies that can be used to support the documentation and communication of TD items.

Status

Recommendations

R1_DOC_T1.

If relevant, use the proposed Artifact 5 (Template for documenting TD items). This template can be tailored or instantiated to other artifacts/tools used in the project’s context, such as a worksheet.

Status

R2_DOC_T1.

Look for specific SE technologies proposed for TD documenting or proper SE technologies that can be used for this purpose. These technologies should have the potential to inform stakeholders about the existing TD items in the project. See the list of some such technologies here.

Status
Task DOC_T2.

Adopt the defined SE technologies to support the documentation and communication of TD items.

Status

Activity DOC_2: Register and Communicate information regarding TD items and decisions about them

Information about TD items should be registered and communicated to stakeholders to make the management of such debts more effective.

Task DOC_T3.

Register information of each TD item from the backlog to support decision-making. Some relevant information about TD items to be registered is its data of occurrence, intentionally, type, identified causes, potential impacts, compromised internal quality attributes, estimated costs (principal, interest, and total), measured criticality, estimated priority, possible scenarios’ changes, and status.

Status

Recommendations

R1_DOC_T3.

If relevant, use the proposed Artifact 5 (Template for documenting TD items). To drive the documentation of each TD item.

Status

R2_DOC_T3.

Use the defined technologies to document TD items.

Status
Task DOC_T4.

Update, when applicable, the information about each unpaid TD item. For instance, it can be done in each project’s iteration for those outstanding TD items.

Status
Task DOC_T5.

Communicate to the stakeholders the existence of TD items.

Status

Recommendations

R1_DOC_T5.

Use the defined technologies to communicate to the stakeholders the existence and information about TD items. Besides, TD items can be communicated to stakeholders at technical project meetings and reported using tools for management and communication adopted in the project.

Status

Activity DOC_1: Define and use specific SE technologies to document TD

Project members can define and adopt particular SE technologies to support the documentation of TD items.

Task DOC_T1.

Identify and define SE technologies that can be used to support the documentation and communication of TD items.

Status

Recommendations

R1_DOC_T1.

If relevant, use the proposed Artifact 5 (Template for documenting TD items). This template can be tailored or instantiated to other artifacts/tools used in the project’s context, such as a worksheet.

Status

R2_DOC_T1.

Look for specific SE technologies proposed for TD documenting or proper SE technologies that can be used for this purpose. These technologies should have the potential to inform stakeholders about the existing TD items in the project. See the list of some such technologies here.

Status

Activity DOC_1: Define and use specific SE technologies to document TD

Project members can define and adopt particular SE technologies to support the documentation of TD items.

Task DOC_T2.

Adopt the defined SE technologies to support the documentation and communication of TD items.

Status

Activity DOC_2: Register and Communicate information regarding TD items and decisions about them

Information about TD items should be registered and communicated to stakeholders to make the management of such debts more effective.

Task DOC_T3.

Register information of each TD item from the backlog to support decision-making. Some relevant information about TD items to be registered is its data of occurrence, intentionally, type, identified causes, potential impacts, compromised internal quality attributes, estimated costs (principal, interest, and total), measured criticality, estimated priority, possible scenarios’ changes, and status.

Status

Recommendations

R1_DOC_T3.

If relevant, use the proposed Artifact 5 (Template for documenting TD items). To drive the documentation of each TD item.

Status

R2_DOC_T3.

Use the defined technologies to document TD items.

Status
Task DOC_T4.

Update, when applicable, the information about each unpaid TD item. For instance, it can be done in each project’s iteration for those outstanding TD items.

Status
Task DOC_T5.

Communicate to the stakeholders the existence of TD items.

Status

Recommendations

R1_DOC_T5.

Use the defined technologies to communicate to the stakeholders the existence and information about TD items. Besides, TD items can be communicated to stakeholders at technical project meetings and reported using tools for management and communication adopted in the project.

Status

TDM Guidelines