Skip to content
Unknown's avatar

Surfing Complexity

Lorin Hochstein's ramblings about software, complex systems, and incidents.

Tag: documentation

Code is for reading, docs are for writing

  1. The documentation is out of date, you’ll have to read the code. Make sure the code you write will be readable by others.
  2. Write documentation. Yes, it will go quickly out of date, but in the act of explaining how the software works to others, you’ll force yourself to acquire a better understanding of how it works.
Lorin Hochstein software Leave a comment December 12, 2011December 12, 2011 1 Minute
  • lorinhochstein.org
  • Bluesky
  • Mastodon
  • Saturation at GitHub: the saga continues
  • How the incident happened: a play in one act
  • Thoughts on the July 8th Telstra outage report
  • Thoughts on the Buildkite Aug 25 incident
  • Quick thoughts on GitHub Actions Aug 26 incident
Blog at WordPress.com.
  • Subscribe Subscribed
    Surfing Complexity
    Join 262 other subscribers

    Have a WordPress.com account? Log in now.

  • Surfing Complexity
    View site in Reader
    Manage subscriptionsSign upLog in
    Report this content
    Collapse this bar