Some Quick Thoughts about Documentation
summary
Documentation splits into two concrete kinds: code comments that explain why and how not what and API docs that state exact behavior. Comments must explain months starting at zero so adding one is justified. API docs need a typical case plus edge cases (insert at 0, at length, negative or out‑of‑bounds) and show whether insertion is before/after and whether the array remains unchanged for bad indexes. Meaningful names beat foo/bar; good examples take work but prevent code dives.
AI-written summary · about
chapters (4)
- 0:00Start
- 0:19One Thing You Should Never Believe
- 0:39Documentng Code: Tell why or how, not what.
- 0:59Documenting an API: It's all about the "what."
related talks
01h 24mWriting Documentation - Practices and Theory
46mTechnically Speaking: Improve your code with documentation
30mA Documentation Talk
29mHumanizing Your Documentation
51mTechnically speaking improve your code documentation
29mHumanizing Your Documentation
23mWriting Good Documentation for Developers
34mHumanizing Your Documentation