Ask HN: Given the choice, would you write documentation if you didn't have to?

by devstein on 4/1/2025, 11:50:51 PM with 4 comments
I personally find writing internal documentation very monotonous even though I know it's important.

I'm curious if you were told you could have decent internal documentation automatically generated for you that were good enough, but not competitive w/ human maintained docs.

Would you still take the effort to write your own documentation?

  • by JohnFen on 4/2/2025, 12:57:30 AM

    Yes, I would. Writing documentation is an integral part of my development process. It's part of how I plan and think. It's not optional unless the project is simple.

  • by allears on 4/2/2025, 12:07:53 AM

    Nope. Writing documentation for myself does two important things. First, it helps me clarify my own thinking, often leading to better code. Second, when I inevitably have to modify or maintain my own code months later, it reminds me of my original intent.