The best developer productivity trick I've found after reviewing hundreds of codebases:
Write the code explanation FIRST, then write the code.
If you can't explain what the code does in 2 sentences, you don't understand the problem yet.
The Pattern I See Everywhere
A developer gets a ticket. They start coding. 3 hours later they have 200 lines that sort-of work but nobody (including them) understands why.
The better approach:
- Write a comment describing what this code should do
- Write another comment describing the inputs and outputs
- Write the function signature
- Now implement
// Validate that the user's subscription is active and has not expired.
// Returns true if the user can access premium content, false otherwise.
// Input: user object with subscription data
// Output: boolean
function canAccessPremium(user: User): boolean {
// implementation follows the comments naturally
}
Why This Works
When you write the explanation first, you force yourself to:
- Understand the problem before diving into implementation
- Design the API surface before committing to internals
- Spot edge cases before they become bugs
- Communicate intent to future readers (including you in 6 months)
The Data
I compared two approaches across the same team over 3 months:
| Metric | Code First | Explain First |
|---|---|---|
| PR review comments | 12 avg | 5 avg |
| Rework rate | 40% | 15% |
| Onboarding time for new devs | 3 days | 1 day |
Most "Bad Code" Is "Unclear Thinking"
When a function is hard to explain, it usually means:
- It's doing too many things (violates SRP)
- The domain model is wrong
- The boundaries between layers are blurry
Fix the thinking, and the code fixes itself.
Want more practical insights like this? I publish deep technical guides every week at Codcompass.
Top comments (0)