Making Codebases Easier to Learn and Maintain
summary
Shows concrete changes: docstrings that state purpose and why not just parameters, repo layout that pull tests out of source and separate interface from internals, code refactors that turn a 300‑line main into named functions, an explicit step of convert to base64 for safe strings with rationale, and test organization that labels requirements edge cases and regressions and uses CSV fixtures. Examples are short prototypes written for the slides not lifted from production.
AI-written summary · about
chapters (20)
- 0:00Intro
- 0:33Welcome
- 1:01Notes
- 1:30Lack of Clarity
- 1:52Benefits
- 3:06Professionalism
- 3:43Rubric
- 6:08Docstring
- 8:00Improving Docstrings
- 9:45Alternative
- 10:22Structure
- 11:05Maintainability
- 13:00Understanding goes backwards
- 13:28Dock string
- 14:43Code implementation
- 16:50Improving readability
- 17:17Modularity
- 20:12Testing
- 23:46Conclusion
- 23:58Conclusions
related talks
52mThe Code is Documentation Enough
49mExplain Yourself! Documentation for Better Code
41mHow to write maintainable code
50mThe Code is Documentation Enough
26m(Professionally) Coding with Others
01h 29mBetter Code and Collaboration through Open Source Concepts, Dev Containers....
48mRefactoring from Good to Great - A Live-Coding Odyssey
35mFive Lines of Codes