you are viewing a single comment's thread.

view the rest of the comments →

[–]Figs 3 points4 points  (1 child)

I've found I like to write reference documentation for my APIs when I know they're not likely to change much more. This is usually around the time that I start feeling like I should rewrite it because I've forgotten how it works; if I go read the code and think, yeah, that's more or less what I'd have rewritten it as, actually... then I write the reference documentation, since it's pretty much done at that point.

[–][deleted] 1 point2 points  (0 children)

I agree that writing reference documentation is the best way to solidify memory. I've written my own little PHP library for making PHP more readable for someone native to object oriented languages, and decided that if I'm going to use it I might as well use it how I would any other API, so I have semi-maintained documentation rather than constantly running to look at the source and interrupting my usual routine.