Profile picture
Allen Holub @allenholub
, 5 tweets, 1 min read Read on Twitter
There's nothing in any Agile practice framework or philosophy that says that you shouldn't document. However, writing documentation that's obsolete the moment it's written is just waste. The solution is to write code that doesn't require formal documentation. 1/
That goes way beyond just picking good names for things (though that helps) and adding comments (which usually don't). The code has to be the simplest possible solution to the problem in front of you and structured for readability. 2/
Well structured microtests demonstrate how the code should be used. Well-structured acceptance tests show you how the larger subsystems and services work together. Both of these are better than formal documentation because they adapt to changes in real time. 3/
Code that's structured to reflect the structure and communication within the business is self documenting if you understand the business. Understanding the business is an essential part of programming. If you don't, then learn. 4/
The programmers have to fanatically enforce modular boundaries and well defined portals into subsystems. If you do all the above, the need for system-level documentation is virtually eliminated. 5/5
Missing some Tweet in this thread?
You can try to force a refresh.

Like this thread? Get email updates or save it to PDF!

Subscribe to Allen Holub
Profile picture

Get real-time email alerts when new unrolls are available from this author!

This content may be removed anytime!

Twitter may remove this content at anytime, convert it as a PDF, save and print for later use!

Try unrolling a thread yourself!

how to unroll video

1) Follow Thread Reader App on Twitter so you can easily mention us!

2) Go to a Twitter thread (series of Tweets by the same owner) and mention us with a keyword "unroll" @threadreaderapp unroll

You can practice here first or read more on our help page!

Did Thread Reader help you today?

Support us! We are indie developers!


This site is made by just three indie developers on a laptop doing marketing, support and development! Read more about the story.

Become a Premium Member and get exclusive features!

Premium member ($30.00/year)

Too expensive? Make a small donation by buying us coffee ($5) or help with server cost ($10)

Donate via Paypal Become our Patreon

Thank you for your support!