RubyConf 2018 - Documentation Tradeoffs and Why Good Commits Matter by Greggory Rothmeier
361 views · Published 4 December 2018 · 28:35 · Indexed 11 October 2026
Channel: Confreaks · 2018 · Science & Technology
RubyConf 2018 - Documentation Tradeoffs and Why Good Commits Matter by Greggory Rothmeier We've all thought "what is this thing supposed to do?" or "why was this done that way" moment when looking through codebases and unless there's documentation or you can find the author, the answer is often hard to find. There are many options to document code from comments to internal wikis, so I'll discuss a heuristic for evaluating the options based on the accessibility (how far away is the answer?) and accuracy (how likely is it that what I'm reading is out of date?) to build a case that the git commit message is likely where you should spend your energy documenting. I'll share my workflow and
More from this channel
-
48:58
Ruby Software Continuously Delivered and Exhaustively Explained by Brian Guthrie, Srushti Ambekallu
-
40:58
Jruby Polyglot Heaven by Thomas E Enebo and Charles Oliver Nutter
-
36:46
Your tests are lying to you by Chris Parsons
-
23:46
KidsRuby: Think Of The Children! by Ron Evans
-
52:05
Resources, For Real This Time (with Webmachine) by Sean Cribbs
-
38:28
Just Say No To :nodoc: and Document Your Code! by Loren Segal
-
37:53
Scaling Ruby with Actors, or How I Learned to Stop Worrying and Love Threads by Mike Perham
-
40:10
Next Level Virtual Machine Maneuver! by Mitchell Hashimoto