Technically Speaking: Improve your code with documentation
summary
Claim: documentation measurably speeds onboarding and future maintenance; evidence: an open‑source bingo plugin released without docs resurfaces four years later broken and time‑consuming to fix. Tools actually recommended: READMEs, targeted code comments that add context not restate code, scripted screencasts plus written steps for accessibility, templates, timestamps, and stakeholder review. Prioritize recent and high‑usage features, test instructions with nonexperts, and write as you go so docs are integrated like funfetti, not sprinkled on at the end.
AI-written summary · about
chapters (21)
- 0:00Start
- 4:14Technical Blog
- 9:23What Exactly Is Technical Writing
- 10:37Why Does the Soliloquy Exist in the Play
- 12:53Writing Is Good for You as a Developer
- 16:38How To Deliver Our Writing
- 23:01Internal Documentation
- 24:32Best Time To Write Documentation
- 25:05Bad Comment
- 26:22Bad Instructions
- 27:23Writing Documents from Scratch
- 32:08Missteps
- 33:36Feedback
- 34:32Questions
- 38:49How Do You Keep Your Documentation up to Date
- 39:47What's the Most Important Thing for Your Users
- 40:36Is the Technical Writer At All Most of the Time Available Only on Big Site's Company
- 42:10How Do You Know What To Include and What Not To Include
- 43:05Curse of Knowledge
- 43:49Code Reviews
- 44:35Technical Writing Reviews
related talks
51mTechnically speaking improve your code documentation
52mTechnically Speaking: improve your code with documentation
01h 14mTechnically speaking: Improve Your Code With Documentation
28mImproving Your Documentation: A talk for developers who want to write stuff good
01h 24mWriting Documentation - Practices and Theory
39mDevelopers Documentation: your hidden strength
29mHumanizing Your Documentation
37mHumanising Your Documentation