Self-Documenting Code

Self-Documenting Code

What do we want? All the documentation! Are we going to read it? Only sometimes!

So, you need to be sneaky! The only reliable way to get other devs to read your docs is to trick them into it.

Self-Documenting Code

Concept 4: Embrace Copy-Paste

Jul 1, 2025• Self-Documenting Code
What’s the point of documentation? To help other people use your code.
Self-Documenting Code

Concept 3: Abstract functions and code patterns

May 9, 2025• Self-Documenting Code
To reiterate, what do we want: to not read the docs, but still know everything...
Self-Documenting Code

Concept 2: Error msgs with calls to action

May 5, 2025• Self-Documenting Code
To reiterate from the previous chapter: Why do we want self-documenting code? Because then future...
Self-Documenting Code

Concept 1: assert finds its calling

Apr 17, 2025• Self-Documenting Code
How much documentation, dev-documentation does your app have? Presumably less than it should have. At...

View whole archive

Collections of posts 📦

Occasionally, a topic is too broad for a single post, so I split it into a series of related posts.

API Resilience PatternsBuilding Blocks CollectionCognitive Biases in CodeSelf-Documenting Code

All Topics

AlgorithmsCeleryCode PatternsCode StyleDatabaseEngineering ResearchGitMastering TimeNetworkingOpinionPeopleSoftware Design PrinciplesSystem DesignTechnical WritingTools