Java Project Documentation
<p>I need to document a Java project. I am a C# Programmer and Systems Analyst. But I am new to Java.</p>

<p>I have the directories checked out of SVN.</p>

<p>These directories include the source directories, WEB-INF and other files required for definition of the project, classpath etc.</p>

<p>I understand that the files essentially belong either of the following three categories</p>

<ol>
<li>Source code files / directories that are based on the way the packages are structured (.Java)</li>
<li>Directories / Files required for project definition, compiler settings etc</li>
<li>Files required for deployment.</li>
</ol>

<p>The project is (as most Java projects are) an Eclipse based project designed to be hosted on Tomcat.</p>

<p>Now, give the above information I have decided to document the entire project into three different documents</p>

<ol>
<li>A document explaining the source code etc.</li>
<li>A document explaining the purpose of the files &amp; directories that are required for compiler settings, project definitions etc</li>
<li>A document that explains the deployment directory structure.</li>
</ol>

<p>Or alternatively I could create a single document with three sections that explain 1-3 above.</p>

<p>Now, questions</p>

<ol>
<li>Is this the right approach? </li>
<li>Are there any other methodologies that I can follow or borrow from?</li>
<li>Are there any other suggestions etc that you can add to this approach</li>
</ol>

<p>Any additional info will be of use.</p>

<p>Thanks a ton in advance</p>
