Re-reading docs

autarch on 2003-03-11T03:41:11

No, not other people's, my own.

I've found that periodically re-reading the docs of my modules is a good habit, as it helps me spot typos and thinkos that have gone unreported, as well as outright mistakes and holdovers from past versions which should have been changed but weren't.

---

new brain every three months

merlyn on 2003-03-11T13:39:23

It's my theory that my brain gets entirely replaced every three months. That's about how long it is before my code doesn't make sense without comments or additional documentation. That's how long I remember why I was being particularly clever. That's why it's important to put comments on things: it's not just for the next guy, it's for me three months from now.

And as you're seeing, that's how long it is before you're a "fresh reader" on a doc. Yes, good idea to go back, with your new brain. Three months.

Re:new brain every three months

dlc on 2003-03-11T13:55:35

That's about how long it is before my code doesn't make sense without comments or additional documentation.

Luckily, a lot of your code comes with a column's worth of commentary. You get to rediscover what you were thinking along with the rest of us.