Question

如何书写Java项目的开发文档

项目开发期间，如有新人进来，需要参与该项目，需要新人能够通过文档能够熟悉项目的结构，功能，开发环境，运行环境；使用技术等；需要什么样的文档及其格式

Answer 1

我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。。
人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。

Answer 2

现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。。
人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板

Answer 3

现在很多文档的编写均有自己的固定格式，这方面百度文库里面就有不少可以参考的文档模板。现在以Java方向的文档为主，简单结束一下。

1人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。
2要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。
3先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。

Answer 4

文档没有固定的格式，文档的目的在于记录、在于交流，因此写清楚就可以了。

Answer 5

如果是有项目经验的新同事,通过需求分析,概要设计,详细设计,数据库设计,再通过项目代码,应该就能熟悉系统了.