java项目开发文档怎么写

java开发设计文档怎么写

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

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

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

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

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

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

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

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

3.软件开发中详细设计文档怎么写

原发布者：阳阳1A

QR-RD-022(Ver1.2)XXX系统详细设计说明书（内部资料请勿外传）XX公司版权所有不得复制文档变更记录1.引言1.1编写目的和范围说明写这份详细设计说明书的目的。本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。1.2术语表定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。1.3参考资料列出有关资料的名称、作者、文件编号或版本等。参考资料包括：a.需求说明书、架构设计说明书等；b.本项目的其他已发表的文件；c.引用文件、资料、软件开发标准等。1.4使用的文字处理和绘图工具文字处理软件：wordoffice绘图工具：Visio2.全局数据结构说明本章说明本程序系统中使用的全局数据常量、变量和数据结构。2.1常量staticStringSERVER_ADDRESS服务器地址booleanloginFlag登录状态2.2变量BlueUserInfo 用户账户结构体2.3数据结构包括数据结构名称，功能说明，具体数据结构说明（定义、注释、取值）等。3.模块设计3.1用例图3.2功能设计说明3.2.1登录模块模块1主要分为以下几个子模块：子模块1、子模块2和子模块N。3.2.1.1设计图

4.java 项目需求文档要怎么写

需求文档一般分两类

需求调研报告

需求分析报告

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

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

项目的背景

项目的目标

项目的范围

用户特点

5.java面试官问有没有写过文档（面试java程序员）,我想知道写文档是

我想他的文档是指在项目开发过程中不同阶段的文档

我们项目组开发基本是基于瀑布模型开发每个阶段都会输出文档指导后续工作开展

一般se下发需求后由我们出详细需求设计文档

代码开发完成了转测试时我们会写数据库设计文档，操作手册（这个也算）

还有就是版本升级说明书版本功能清单软件介绍

这个是大概的文档还有其他的。文档编写时间主要是代码开发前与转测试后

6.java编写的记事本开发文档如何写我们用Java编写了一个记事本爱问知

class Pop_undo_actionAdapter implements Java。

awt。event。

ActionListener{ Jsb adaptee; Pop_undo_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。

pop_undo_actionPerformed(e); } } class Pop_cut_actionAdapter implements java。 awt。

event。ActionListener{ Jsb adaptee; Pop_cut_actionAdapter(Jsb adaptee){ this。

adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。 pop_cut_actionPerformed(e); } } class Pop_copy_actionAdapter implements java。

awt。event。

ActionListener{ Jsb adaptee; Pop_copy_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。

pop_copy_acionPerformed(e); } } class Pop_paste_actionAdapter implements java。 awt。

event。ActionListener{ Jsb adaptee; Pop_paste_actionAdapter(Jsb adaptee){ this。

adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。 pop_paste_actionPerformed(e); } } class Pop_delete_actionAdapter implements java。

awt。event。

ActionListener{ Jsb adaptee; Pop_delete_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。

pop_delete_actionPerformed(e); } } /******************* Event class end **********************************/ /************************************************************* * title: DlgText。 java * author: jeason * date: 2004-12-21 **************************************************************/ package jeason; import java。

awt。*; import java。

awt。event。

*; import javax。swing。

*; public class Dlgtext extends JDialog{ private boolean check=false; JLabel text=new JLabel( ); JButton BTnOk=new JButton( ); JButton btnNo=new JButton( ); FlowLayout flowLayout1=new FlowLayout(); Dlgtext(){ this(null,"",false); } Dlgtext(Frame frame, String title, boolean modal){ super(frame,title,modal); text。 setText（" 你要保存吗？ "）； text。

setSize(200,60); this。setSize(200,80); this。

setModal(true); btnOk。setText（"确定（Y）"); btnOk。

setMnemonic（´Y´）；。

7.求写JAVA和数据库的设计文档技巧

1引言。

2 1.1编写目的。 2 1.2背景。

2 1.3定义。 2 1.4参考资料。

2 2外部设计。 2 2.1标识符和状态。

2 2.2使用它的程序。 3 2.3约定。

3 2.4专门指导。 3 2.5支持软件。

3 3结构设计。 3 3.1概念结构设计。

3 3.2逻辑结构设计。 3 3.3物理结构设计。

4 4运用设计。 4 4.1数据字典设计。

4 4.2安全保密设计。 4 数据库设计说明书（GB8567——88）1引言 1.1编写目的说明编写这份数据库设计说明书的目的，指出预期的读者。

1.2背景说明： a. 说明待开发的数据库的名称和使用此数据库的软件系统的名称； b. 列出该软件系统开发项目的任务提出者、用户以及将安装该软件和这个数据库的计算站（中心）。1.3定义列出本文件中用到的专门术语的定义、外文首字母组词的原词组。

1.4参考资料列出有关的参考资料： a. 本项目的经核准的计划任务书或合同、上级机关批文； b. 属于本项目的其他已发表的文件； c. 本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。

2外部设计 2.1标识符和状态联系用途，详细说明用于唯一地标识该数据库的代码、名称或标识符，附加的描述性信息亦要给出。如果该数据库属于尚在实验中、尚在测试中或是暂时使用的，则要说明这一特点及其有效时间范围。

2.2使用它的程序列出将要使用或访问此数据库的所有应用程序，对于这些应用程序的每一个，给出它的名称和版本号。2.3约定陈述一个程序员或一个系统分析员为了能使用此数据库而需要了解的建立标号、标识的约定，例如用于标识数据库的不同版本的约定和用于标识库内各个文卷、、记录、数据项的命名约定等。

2.4专门指导向准备从事此数据库的生成、从事此数据库的测试、维护人员提供专门的指导，例如将被送入数据库的数据的格式和标准、送入数据库的操作规程和步骤，用于产生、修改、更新或使用这些数据文卷的操作指导。如果这些指导的内容篇幅很长，列出可参阅的文件资料的名称和章条。

2.5支持软件简单介绍同此数据库直接有关的支持软件，如数据库管理系统、存储定位程序和用于装入、生成、修改、更新数据库的程序等。说明这些软件的名称、版本号和主要功能特性，如所用数据模型的类型、允许的数据容量等。

列出这些支持软件的技术文件的标题、编号及来源。3结构设计 3.1概念结构设计说明本数据库将反映的现实世界中的实体、属性和它们之间的关系等的原始数据形式，包括各数据项、记录、系、文卷的标识符、定义、类型、度量单位和值域，建立本数据库的每一幅用户视图。

3.2逻辑结构设计说明把上述原始数据进行分解、合并后重新组织起来的数据库全局逻辑结构，包括所确定的关键字和属性、重新确定的记录结构和文卷结构、所建立的各个文卷之间的相互关系，形成本数据库的数据库管理员视图。3.3物理结构设计建立系统程序员视图，包括： a. 数据在内存中的安排，包括对索引区、缓冲区的设计； b. 所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分； c. 访问数据的方式方法。

4运用设计 4.1数据字典设计对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷、模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。在本节中要说明对此数据字典设计的基本考虑。

4.2安全保密设计说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑。

java开发设计文档怎么写

java需求文档怎么写

1. java 项目需求文档要怎么写

需求文档一般分两类

需求调研报告

需求分析报告

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

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

项目的背景

项目的目标

项目的范围

用户特点

2. 项目需求怎么写

A、三种编写方法

1、用好的结构化和自然语言编写文本型文档；

2、建立图形化模型，这些模型可以描绘转换过程、系统状态、和它们之间的变化、数据关系、逻辑流或对象类和他们的关系；

3、编写形式化规格说明，这可以通过使用数学上精确的形式化逻辑语言来定义需求。

多种编写方法可在同一个文档使用，根据需要选择，或互为补充，以能够把需求说明白为目的。

B、应有成果

1、各业务手工办理流程文字说明；

2、各业务手工办理流程图；

3、各业务手工办理各环节输入输出表单、数据来源；

4、目标软件系统功能划分（示意图及文字说明）；

5、目标软件系统中各业务办理流程文字说明；

6、目标软件系统中各业务办理流程图（模型）；

7、目标软件系统中各业务办理各环节数据、数据采集方式、数据间的内在联系分析。

8、目标软件系统用户界面图、各式系统逻辑模型图及说明

C、文档工具推荐

1、调研结果《需求分析说明书》格式参照开发文档模板；

2、单位组织结构图、功能模块分解图用VISIO绘制，或直接用WORD中的画图工具；

3、业务流程图用VISIO中的FLOWCHART模板绘制；

4、系统逻辑模型使用ROSE绘制活用VISIO中的UML模板绘制；

5、软件用户界面用VISIO中的WIN95 USER INTERFACE模板绘制；

6、数据物理模型用POWERDESINER绘制；

D、需求文档编写原则

1、句子简短完整，具有正确的语法、拼写和标点；

2、使用的术语与词汇表中所定义的一致；

3、需求陈述应该有一致的样式，例如“系统必须..”或者“用户必须..”，并紧跟一个行为动作和可观察的结果。；

4、避免使用模糊、主观的术语，减少不确定性，如“界面友好、操作方便”；

5、避免使用比较性词语，如“提高”，应定量说明提高程度

3. 来,讨论一下怎么写需求文档吧

用例和UP的讨论

UML 中各种图形的重要性排行

先谈谈我的想法。

1、功能需求；

2、非功能需求或技术需求；

我一般把功能需求划分为几个部分：

a、业务过程；

b、业务规则；

c、业务数据；

非功能需求（技术需求）我就不多说了，大致就是可用性，可靠性，性能，可支持性等等。

1、用例规格说明描述业务过程；

2、业务规则文档描述业务规则；

3、术语表描述业务数据；

4、补充规格说明描述非功能需求（技术需求）；

UP的做法还是很有道理的。这体现了两个原则：

1、分离关注点（每个文档描述相对独立的领域）；

2、减少重复（很多用例都会引用相同的业务规则及业务数据）；

这样便能够尽可能的使文档结构清晰，易阅读，易理解。也便于跟踪和维护。

但另一方面由于将不同的领域分离到不同文件的做法也使得可阅读性有所降低。比如用例规格说明中的业务过程描述时常需要引用业务规则文档中的业务规则及术语表中的业务数据。由于不是很方便在各个文档之间导航，你可能需要打开多个文档进行交叉阅读。这是比较麻烦的，特别是对于用户来说。

而且UP中每个用例都单独作为一个文件存在，这可能是为了便于跟踪及管理的缘故吧。但正如上所述，文件多了看着就觉得不爽了。我觉得完全可以将用例合并到一个文档中。或者几个相对独立的文档中（比如根据子系统划分）。

易理解，

易沟通，

易确认，

易跟踪，

易测试，

易验收

我想我们都应该以这个为目标来进行思考。

推荐链接Java开发新方式：专注UI，快速开发！

4. java面试官问有没有写过文档（面试java程序员）,我想知道写文档是

我想他的文档是指在项目开发过程中不同阶段的文档

我们项目组开发基本是基于瀑布模型开发每个阶段都会输出文档指导后续工作开展

一般se下发需求后由我们出详细需求设计文档

代码开发完成了转测试时我们会写数据库设计文档，操作手册（这个也算）

还有就是版本升级说明书版本功能清单软件介绍

这个是大概的文档还有其他的。文档编写时间主要是代码开发前与转测试后

5. 自己写Java文档一般需要有哪些内容

每个非 private 方法的参数说明，像 getter/setter 这样简单的就省略掉。主要是关键方法和类的设计要有说明。另外，一些方法有内部的实现约定，也就是前提条件，这个在技术上没办法验证的或验证它会影响性能等，我们就只在文档中说明，不在代码中检查了。举个例子，java.util.ArrayList 不是一个线程安全的集合实现类，它就在文档中说明了这点，另一个就是 equals 和 hashcode 方法在你覆盖它时应该同时按相同的算法覆盖两个，只覆盖一个就不符合设计约定。再一个就是简要说明你的关键方法和类是如何设计的。

一个好的文档可以用来回答 What, Why & hoW 这三个 W。

6. 想做java方面的项目有没什么需求文档

能否告诉我你的水平如何？若你只是纯粹想做个项目练练手的话，建议你可以做一些需求简单，但技术方面有些挑战的项目，比如，你可以开发一个象棋或者围棋的人机博弈游戏，自己写一个俄罗斯方块，自己写一个搜索引擎，或者写一个聊天工具都是可以的，这些东西我们平时都玩过或者经常用，需求自然也就十分简单和清楚，不会需要花你很多的时间去做需求的分析，而可以把重点放在项目的设计和实现上，项目的设计和实现对初学者来说很重要，想做好而需求分析或系统分析，若扎实了基本技术技能，效果会更好。

java需求文档怎么写

java的开发文档怎么写

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

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

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

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

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

3. java编写的记事本开发文档如何写我们用Java编写了一个记事本爱问知

class Pop_undo_actionAdapter implements Java。

awt。event。

ActionListener{ Jsb adaptee; Pop_undo_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。

pop_undo_actionPerformed(e); } } class Pop_cut_actionAdapter implements java。 awt。

event。ActionListener{ Jsb adaptee; Pop_cut_actionAdapter(Jsb adaptee){ this。

adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。 pop_cut_actionPerformed(e); } } class Pop_copy_actionAdapter implements java。

awt。event。

ActionListener{ Jsb adaptee; Pop_copy_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。

pop_copy_acionPerformed(e); } } class Pop_paste_actionAdapter implements java。 awt。

event。ActionListener{ Jsb adaptee; Pop_paste_actionAdapter(Jsb adaptee){ this。

adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。 pop_paste_actionPerformed(e); } } class Pop_delete_actionAdapter implements java。

awt。event。

ActionListener{ Jsb adaptee; Pop_delete_actionAdapter(Jsb adaptee){ this。 adaptee=adaptee; } public void actionPerformed(ActionEvent e){ adaptee。

awt。*; import java。

awt。event。

*; import javax。swing。

setSize(200,60); this。setSize(200,80); this。

setModal(true); btnOk。setText（"确定（Y）"); btnOk。

setMnemonic（´Y´）；。