Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

That's why you keep the old comments and write the changes within.

    "If loop does something" #rev1

    "If loop did do something, it now does something twice" #rev2

    "If loop doesn't do something, it does something three times" #rev3

    "we loop three times because we processing supervariables" #rev4
And you have an wrong illusion of documentation. You don't need ascii diagrams. Why not a scribble in a sketch book? Whiteboards and photography exist. And the method above doesn't require you too redraw. You've already got the first and last revision. Besides, during an documentation cycle of your projects life-cycle is where you update all documentation.

> you'll either get less refactors, or outdated comments

If so, you're not disciplined enough. If your project is to be handed over down the line, more documentation is better than any and any documentation is better than none.



Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: