top | item 43552462

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

1 points| devstein | 11 months ago

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?

4 comments

order

JohnFen|11 months ago

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.

devstein|11 months ago

I agree about docs as a tool for thought.

What about the other side of docs, keeping them up to date?

allears|11 months ago

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.