Remembering what you've written
I have folks at work ask me details about code I’ve written and how it works. Almost always, I have to go back and at least look at what I’ve written before I can even say for sure that I wrote or worked on the code. Isn’t that sad?
This forgetfulness with regard to what I have written is annoying. And I’d like to brainstorm some ideas here about how someone with the same problem might move around it.
Wiki- fluid / roll your own
- fits high level and low level documentation
- wikis can be as difficult to navigate as the code if not maintained
- details on specific classes and methods
- auto generated; just document your code and wola!
- harder to get high level overview of what the pieces are and how they fit together
- the code speaks for itself
- if the code is well written, no one should be knocking at your door for an overview
- “document” as needed; no time spent for extra documentation that may never be used
- harder to get high level overview of what the pieces are and how they fit together
What other options have I missed here? What, in your experience, has been the best way to document what you have written?
