Java项目文档

Question

我需要记录一个Java项目.我是C#程序员和系统分析师.但我是Java新手.

我已经从SVN中检出了目录.

这些目录包括源目录,WEB-INF和定义项目所需的其他文件,类路径等.

据我所知,这些文件基本上属于以下三个类别之一

1. 基于包结构方式的源代码文件/目录(.Java)
2. 项目定义,编译器设置等所需的目录/文件
3. 部署所需的文件.

该项目(与大多数Java项目一样)是一个基于Eclipse的项目,旨在托管在Tomcat上.

现在,给出上述信息,我决定将整个项目记录到三个不同的文档中

1. 解释源代码等的文档
2. 一个文档,解释了编译器设置,项目定义等所需的文件和目录的用途
3. 解释部署目录结构的文档.

或者我可以创建一个单独的文档,其中有三个部分可以解释上面的1-3.

现在,问题

1. 这是正确的方法吗？
2. 我还可以遵循或借用其他任何方法吗？
3. 是否有任何其他建议等可以添加到此方法

任何其他信息都将有用.

非常感谢提前

Answer 1

我认为你走在正确的轨道上.在项目中,您需要满足三个文档需求

1. 用户文档这包括一个文档,说明应用程序的内容,以及如何启动/访问ut.

2. 开发文档这至少包括Javadocs,源代码目录结构的描述,构建过程(即如何编译项目),编译器时间依赖性,开发标准,如何设置数据库以进行开发,以及如何从存储库中获取源代码.这些是让别人在您的项目中工作所需的最低限度.此外,随着项目复杂性的增加,我喜欢为系统中的常见任务组合一系列"如何"(即:"如何为给定操作留下审计跟踪","如何使用日志框架","如何管理异常"等等,主要类及其关系的描述.如果您使用数据库,并且数据库模式与域类不是一对一的,那么我将添加模式文档.

3. 部署文档这基本上是应用程序的安装手册,描述了使其运行所需的任何步骤:将WAR置于Tomcat中,针对数据库运行脚本,需要修改的配置文件等等.

如你所见,你已经部分解决了其中两个问题.从小而简单开始,并在需要时添加其余部分.

它还有助于检查您的组织是否有任何文档标准.