4 ms·
I would rather read your writing about the mental model or problem solving, problem definition, data structures you solved with your code than the code itself.
by samsquire 3y ago
I would rather read your writing about the mental model or problem solving, problem definition, data structures you solved with your code than the code itself.
mpweiher:
"Show me your flowchart and conceal your tables, and I shall continue to be mystified. Show me your tables, and I won't usually need your flowchart; it'll be obvious."
Fred Brooks, The Mythical Man Month
If I understand the problem your code solves, then I can probably understand the words you use to describe the solution to that problem and therefore understand the steps your code takes to implement that solution.
Documentation is underrated.
A well documented codebase is one that doesn't tell you what the code does (the code tells you what the code does in minute detail) but tells you the problem and the solution the code is solving. Please tell me what the code does from a problem solving perspective.
If I can't understand your code, then your code is legacy to me unfortunately. Tell me the problem and mental model the code is implementing and I can rewrite it or avoid rewriting it because I have your implementation, I understand it and I don't need to rewrite it.