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

我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。

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

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

我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。

。人员流动是项目进行中比较让人头疼的事情。

做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。

比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。

java 项目需求文档要怎么写？

需求文档一般分两类

需求调研报告

需求分析报告

调研报告：是记录的用户的原始需求，基本上可以算做是和用户沟通的原始记录。

分析报告：是对调研报告进行归类分析的结果。一个比较全面的文档了，在这个文档里面一般包含以下内容：

项目的背景

项目的目标

项目的范围

用户特点

相关技术、规范标准等

相关约束

用户的组织结构、角色等

用户需要的功能点，这些功能的优先级，业务流程、功能特点，有没有特殊需求等等

总而言之，需求分析报告的下一站是给设计人员的，设计人员看到需求分析报告就知道系统应该包含哪些功能点、权限设计、流程设计等，这些内容都可以直接从需要分析报告里面得出

java项目做完怎么写说明文档

如果你参与了项目，最好写清楚参与的项目的时间，项目描述，自己在这个项目中的主要责任，以及在项目中用到的技术和自己在项目中学到的东西完成了xxx部分编码/测试/设计，（在xxx时间内）实现了yyyy功能，使得项目获得了zzzz收益，获得dddd奖励。

可以在项目描述中谈谈自己在实现某项功能时用到了什么技术，如用MySQL的 limit语句实现分页功能先介绍一下项目要实现的功能，在介绍下程序的结构划分（MVC），再谈下MVC各是用什么技术实现的（如View用了JSP、JSTL,Controller使用Struts2的过滤器。

。），然后介绍下实现主要功能时具体用了哪些技术（建议你多谈点对AJAX的理解）。

Java web设计文档怎么写

自己百度“宿舍管理系统”设计方案（详细设计，设计文档）类似的关键字看看，这个和JAVA WEB没啥具体关系，javaweb只是它的表现形式。

你参考网上的文档，按照模版把项目基本内容填一下，功能方面：你要的功能也就无非是"入住"“搬出”“查看”“打印”四大功能而已，对这四大功能详细说明一下（对每个功能采用语言+图例的形式就更好了）就算是一个简单的设计文档了https://wenku.baidu.com/view/15797606de80d4d8d15a4f2b.html这个我看挺合适你要的。