You should remove half of your documentation : vimarsana.com

You should remove half of your documentation

“Always write documentation for everything” seems like advice that you can give anyone in any situation and it will make everything better. It’s not. There is a cost and risk associated with every line of documentation you write, and this is exactly what this blog post is about.
When I say “documentation”, I mean all forms of it, including README, Markdown files, docstrings, and code comments.
Why your documentation sucks It requires maintenance.

Related Keywords

, Misc ,

© 2025 Vimarsana