http://www.jessirae.com/blog/articles/2009/10/06/remembering-what-youve-written en-us 40 <p>I have folks at work ask me details about code I&#8217;ve written and how it works. Almost always, I have to go back and at least look at what I&#8217;ve written before I can even say for sure that I wrote or worked on the code. Isn&#8217;t that sad?</p> <p>This forgetfulness with regard to what I have written is annoying. And I&#8217;d like to brainstorm some ideas here about how someone with the same problem might move around it.</p> <strong>Wiki</strong> <ul> <li>fluid / roll your own</li> <li>fits high level and low level documentation</li> <li>wikis can be as difficult to navigate as the code if not maintained</li> </ul> <strong>Better Commenting for auto-generated Javadoc/Rdoc</strong> <ul> <li>details on specific classes and methods</li> <li>auto generated; just document your code and wola!</li> <li>harder to get high level overview of what the pieces are and how they fit together</li> </ul> <strong>Nothing at all</strong> <ul> <li>the code speaks for itself</li> <li>if the code is well written, no one should be knocking at your door for an overview</li> <li>&#8220;document&#8221; as needed; no time spent for extra documentation that may never be used</li> <li>harder to get high level overview of what the pieces are and how they fit together</li> </ul> <p>What other options have I missed here? What, in your experience, has been the best way to document what you have written?</p> Tue, 06 Oct 2009 16:33:00 -0400 urn:uuid:06a02736-b0bc-4c4a-a97b-ca56e7e08c51 Jessica http://www.jessirae.com/blog/articles/2009/10/06/remembering-what-youve-written technology documentation http://www.jessirae.com/blog/articles/trackback/12805