Skip to content

Commit 49f84de

Browse files
committed
fix typo and make sub-list UL to avoid confusion with step numbers referenced below it
1 parent 04c5f7b commit 49f84de

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

blog/2023/what-to-do-when-drowning-in-technical-debt.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: What to Do When You’re Drowning in Tech Debt
33
desc: An explanation of how to frame the discussion so that the business sees value in reducing and preventing technical debt.
44
img: /img/2023/hunters-race-MYbhN8KaaEc-unsplash.jpg
5-
date: 2023-03-30
5+
date: 2023-03-03
66
tags:
77
- technical debt
88
- software craftsmanship
@@ -19,18 +19,18 @@ It's not _dark science_ or _rocket surgery_ to write decent software. You can ge
1919
2. Write tests that will validate when you've reached the goal. When the tests pass, stop working. If your tests are passing and you know there's more features to add or more edge cases to handle, then you need to add more failing tests first.[^0]
2020
3. Write the code that makes the tests pass, ignoring best practices – get to passing tests as quick and dirty as you can!
2121
4. Refactor the code to follow all of those best practices you ignored in the last step. Fortunately you now have the tests to give you confidence that you haven't broken anything during your refactoring.
22-
1. Remove duplication
23-
1. Employ [SOLID principles](https://en.wikipedia.org/wiki/SOLID)
24-
1. Make it readable for the developer who has to debug it in 10 years and doesn't know what you're thinking today. It might not be you.[^1]
25-
1. etc...
22+
- Remove duplication
23+
- Employ [SOLID principles](https://en.wikipedia.org/wiki/SOLID)
24+
- Make it readable for the developer who has to debug it in 10 years and doesn't know what you're thinking today. It might not be you.[^1]
25+
- etc...
2626
5. Submit for code review, and incorporate feedback as appropriate.
2727

2828
[^0]: It is a legitimate strategy to write a prototype of the feature first before you write tests if you don't yet understand what it will take to implement the feature. You can't test something you don't understand, so write a throw-away prototype to learn from, then throw it away, and write your tests for the real implementation.
2929
[^1]: "Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. Code for readability." - [John Woods](https://stackoverflow.com/a/878436/751)
3030

3131
### Then, why is there always so much technical debt?
3232

33-
**I beleive that we allow "the business" to get in the way of doing our jobs well.**
33+
**I believe that we allow "the business" to get in the way of doing our jobs well.**
3434

3535
Too often, software companies and IT departments are given a project mandate and an allowable time limit to spend working on it. Maybe the CEO talked to customers about it, decided it would be a valuable project, and the customer would need it by a certain date in order to be able to use it.
3636

0 commit comments

Comments
 (0)