Documentation and the Whole nine YARDs
summary
Argues that documentation must be part of development not an afterthought and gives concrete fixes: use YARD to add metadata like param and return tags, write tests against those tags, and run linters. Cites a Rails security bug caused by wrong docs and praises DataMapper’s use of yardstick lints docs and plugins. Demonstrates YARD plugins (yard‑sinatra, yard‑rspec, yard‑pigments), live docs on yardock org, and the concrete rule add @return nil tag and test it.
AI-written summary · about
chapters (5)
- 0:00Start
- 2:29Good Documentation Is Hard To Find
- 3:49Bad Documentation Can Be Serious Bad
- 6:51Your users will like you.
- 16:25Conclusion?
related talks
43mBuilding a Ruby Library the Parts No One Talks About
26mHow to be an Awesome Junior Developer
50mWriting Solid Ruby Code
20mMake it SPECtacular
39mSeven Habits of Highly Effective Gems
20mApplying RSpec Best Practices
41mAPPLICATION ARCHITECTURE: BOUNDARIES, OBJECT ROLES, & PATTERNS
01h 33mLightning Talks