-
Notifications
You must be signed in to change notification settings - Fork 14
Update TechnicalDebtMonitoring.md #305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
- Testing – Unknown or unrecorded test scenarios, lack of test coverage | ||
- Maintenance – Out-of-support products, usually leading to security vulnerabilities | ||
- Process - inefficient or wasteful process steps, this could be related to practice or tooling | ||
- Security - Known and exploitable vulnerabilities |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technical - (heading below)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
line?
- A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboads it is then possible to monitor Technical Debt. | ||
|
||
 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extra blank line (ln 85)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
- A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboads it is then possible to monitor Technical Debt. | ||
|
||
 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Enclose bare links in angle brackets (ln 107-109)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
- A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboads it is then possible to monitor Technical Debt. | ||
|
||
 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing apostrophe (ln 113)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where?
## Points of Contact | ||
|
||
* Policy Owner - Principal Support Developer | ||
- Policy Owner - Principal Support Developer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
end file with newline
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Instability | ||
- Security Concerns | ||
- Add a new section called Status | ||
- Add field for Scheduled Release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
end file with newline
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Security Concerns | ||
* Add a new section called Status | ||
* Add field for Scheduled Release | ||
- A **Technical debt** work item type **MUST** be created in target project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ln 6-7 indent should be 2 spaces
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
* Security Concerns | ||
* Add a new section called Status | ||
* Add field for Scheduled Release | ||
- A **Technical debt** work item type **MUST** be created in target project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ln 15 trailing space
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
found and destroyed
software-engineering-policies/TechnicalDebt/TechnicalDebtPolicy.md
Outdated
Show resolved
Hide resolved
### Strategy | ||
|
||
* A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboads it is then possible to monitor Technical Debt. | ||
- A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboads it is then possible to monitor Technical Debt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboads it is then possible to monitor Technical Debt. | |
- A **Technical debt** work item type **MUST** be created in target project. Using queries and dashboards it is then possible to monitor Technical Debt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
went out of date, but is fixed
- Add new Details section with the following fields (use existing field, do not create a new field): | ||
- Primary Product or Service | ||
- there may be several interconnecting products but which is the main one, if needed, create a separate TD item for each product if they would be addressed separately. | ||
- Technical priority | ||
- TD1 - High business/technical value, high risk debt that needs to be paid off ASAP (a Security tag should automatically be considered for a TD1 prioritisation). | ||
- TD2 - High business/technical value (cost reduction, blocker removing, maintainability improvement), lower risk, a change that should be worked on when time/opportunity permits and is not something that can be accepted or supported long term. | ||
- TD3 - Tech debt that has been accepted as a risk but through paying off would add value through improving usability, maintainability, reliability or performance. | ||
- TD4 - Accepted risk from the business, safe to leave until service reaches end of life. Worth tracking in case developers are working in the area and can complete as quick wins. | ||
- Technical debt type | ||
- Architectural – Tightly coupled systems (lots of criss-crossed dependencies), - restrictive to extension or automation | ||
- Code – Low quality code or ineffective patterns | ||
- Knowledge – lack of documentation or inaccessible documentation | ||
- Automation – Lack of automated tasks forcing manual intervention (Testing, deployments, - backup/restore) | ||
- Testing – Unknown or unrecorded test scenarios, lack of test coverage | ||
- Maintenance – Out-of-support products, usually leading to security vulnerabilities | ||
- Process - inefficient or wasteful process steps, this could be related to practice or - tooling | ||
- Security - Known and exploitable vulnerabilities | ||
- Technical debt impact | ||
- Increased time to deliver | ||
- Unplanned work | ||
- Inaccurate planning | ||
- Disengaged Development teams | ||
- Longer times to recover | ||
- Instability | ||
- Security Concerns | ||
- Add a new section called Status | ||
- Add field for Scheduled Release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whole section seems to have a lot of random spacing and a mix of different hyphenation with some random hyphens at the end of sentences which makes reading it a bit tricky!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think I got them all.
…y.md Co-authored-by: Eleri Valiant <eleri.valiant@ukho.gov.uk>
No description provided.