我需要记录一个Java项目。我是C＃程序员和系统分析师。但我是Java的新手。
我已从SVN中检出目录。
这些目录包括源目录，WEB-INF和定义项目所需的其他文件，类路径等。
据我所知，这些文件基本上属于以下三个类别之一
该项目（与大多数Java项目一样）是一个基于Eclipse的项目，旨在托管在Tomcat上。
现在，提供上述信息，我决定将整个项目记录到三个不同的文档中
或者我可以创建一个单独的文档，其中有三个部分解释上面的1-3。
现在，问题
任何其他信息都可以使用。
提前感谢
答案 0 :(得分：6)
我认为你走在正确的轨道上。在项目中，您需要满足三个文档需求
用户文档 这包括一份说明应用程序内容的文档，以及如何启动/访问ut。
开发文档 这至少包括Javadocs，源代码目录结构的描述，构建过程（即如何编译项目），编译器时间依赖性，开发标准，如何设置数据库以进行开发，以及如何获取来自存储库的源代码。这些是让别人在您的项目中工作所需的最低限度。此外，随着项目复杂性的增加，我喜欢为系统中的常见任务组合一系列“如何”（即：“如何为给定操作留下审计跟踪”，“如何使用日志框架”，“如何管理异常“等等，主要类及其关系的描述。如果您使用数据库，并且数据库模式与域类不完全一对一，我将添加模式文档。
部署文档 这基本上是应用程序的安装手册，描述了使其运行所需的任何步骤：将WAR置于Tomcat中，针对数据库运行脚本，需要修改的配置文件等等。
如您所见，您已经部分解决了其中两个问题。从小而简单开始，并在需要时添加其余部分。
检查您的组织是否有任何文档标准也很有帮助。
答案 1 :(得分：3)
尝试Javadocs链接。如果写得恰当，它将解决上述所有问题。
答案 2 :(得分：0)
解释源代码等的文件。
是。如果您的读者有人试图熟悉项目编写的原因（为什么要创建这个项目），以及项目的整体架构，请接近这一点。
源类上的Javadocs应该解释每个类的作用。您的文档应该将Javadoc绑定在一起，就像教程一样。
解释文件目的的文件＆amp;编译器设置，项目定义等所需的目录。
是
解释部署目录结构的文档。
我想这就是你的构建脚本所做的事情。也许我不明白你对这份文件的期望是什么。
您是否可以添加其他任何建议
除非这是您的开发小组中的任何人第一次记录Java项目，否则应该有其他文档。看看他们做了什么。
如果你是第一个，那么我会说这是一个好的开始。我对第一份文件最感兴趣。你的新程序员想要第二份文件。