Technically Speaking: improve your code with documentation
summary
Argues that integrating docs into development prevents rework and dozens of support emails, describes a practical workflow used at WNET and Google: write while you code, leave targeted code comments, create a README for every project with install, prerequisites, usage and license, and use templates or the README CLI generator by Frank Abgrall. Cites building a 2015 WordPress bingo plugin (later hard to maintain without docs) and contributing to Perspective API as examples that documentation actually saves time. K.I.S.S. and templates
AI-written summary · about
chapters (5)
- 0:00Introduction to docs
- 15:31Why write documentation
- 24:10Optimize deliverables
- 38:24So what and final tips
- 46:40Q&A on documentation
related talks
51mTechnically speaking improve your code documentation
46mTechnically Speaking: Improve your code with documentation
01h 14mTechnically speaking: Improve Your Code With Documentation
01h 24mWriting Documentation - Practices and Theory
28mImproving Your Documentation: A talk for developers who want to write stuff good
56mEffective Documentation: The Key to Open Source Growth
45mDocs or it didn't happen!
51mWriting the Darn Docs