育才学习网1. 怎么写项目开发的文档
1.1.1 项目名称
项目名称（项目类型）
1.1.2 项目开发者
成员一：**
成员二：***
成员三：***
1.1.3 项目开发环境
MyEclipse + Tomcat5.5和MyEclipse（自带）+ SQLServer 2005
1.1.4 系统功能设定
品红商业网分为2大模块：
1.前台系统
## 设定新闻，商品以及购物相关功能：
NEWS：对新闻的增加、删除和查询操作，并且增加上下条功能进行查询，以及最新新闻的显示与增加。
PRODUCT：对商品的增加、删除、修改和查询操作，并且增加分页技术进行查询，以及最新商品的展示与增加；增设对商品的选购，打印清单、结算功能。
TALKING：用户之间的在线聊天，进行互动交流，洽谈业务，对信息发表自己的看法等，并设有广告介绍，让用户了解最新信息。
MESSAGE：客户留言薄，针对各种商情，业务交流进行离线留言，站外，站内用户可以通过此信息及时了解最新资讯，了解用户反馈信息等。
ABOUT：介绍了公司对客户的信心，诚意做出了诚恳的表态。
AFTER：介绍了公司关于商品的售后服务条例等，给客户提供更满意的服务。
COPYRIGHT：介绍了公司的版权信息，以及法律授权及其相关。
2.后台管理系统
## 设定对管理员，用户以及管理员对新闻和商品信息的相关操作。
ADMIN：对用户的查询和删除，对新闻的增加，删除和查询，对商品的增加、删除、修改和查询，都增设了分页技术更有规范的查询。并附有时间，让操作人员在任何时候都能得到精准时间，以提高管理员的时间观念。
1.1.5 项目开发技术
JSP + JavaScript + HTML
1.1.6 设计思路
通过相关技术，一一实现对管理员，站外，站内用户，公司新闻信息，商品信息进行实用的操作。
1.1.7 项目背景
本着为客户提供最优质的服务，项目从多角度考虑需求，以求达到客户所需要的功能，实现零距离的操作。
1.1.8 主要模块讲解
1.1.8.1 模块一
1. 名称：管理员模块
2. 简介：管理员的登录，对相应信息操作
实现了管理员对用户，管理员的操作：
1. 对用户的查询，删除（必要的删除），使用分页技术给管理员更好的视觉效果。
2. 添加管理员使用了MD5加密技术，登录及相关操作时的各种精密验证，达到更高的保密性，安全性。
1.1.8.2 模块二
1. 名称：新闻模块
2. 简介：新闻展示，更新，增加和删除
1.对新闻的查询和删除，使用分页技术给管理员提供更好的操作性能
1.1.8.3 模块三
1. 名称：商品模块
2. 简介：商品展示，更新，增加和删除
1. 对商品的查询、删除、增加和更新，分别使用分页技术给管理员提供更好的操作
1.1.8.4 模块四
1. 名称：用户模块
2. 简介：可以进行授权的操作，登录在线聊天进行交流，登录购物台进行选，购。
1.1.8.5 模块五
1. 名称：论坛模块
2. 简介：可以查看所有的论坛信息，并进行筛选，删除不健康、不文明留言
2. 我该怎么写详细开发文档
以下nbsp；是我们单位的nbsp；项目开发计划书nbsp；希望对你有帮助编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、nbsp；所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开nbsp；发工作。
编制内容要求如下：nbsp;nbsp;nbsp;nbsp;1nbsp；引言nbsp;nbsp;nbsp;1.1编写目的nbsp;nbsp;nbsp;nbsp；说明编写这份项目开发计划的目的，并指出预期的读者。nbsp;nbsp;nbsp;1.2背景nbsp;nbsp;nbsp；说明：nbsp;nbsp;nbsp;a.待开发的软件系统的名称；nbsp;nbsp;nbsp;b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；nbsp;nbsp;nbsp;C.该软件系统同其他系统或其他机构的基本的相互来往关系。
nbsp;nbsp;nbsp;1.3定义nbsp;nbsp;nbsp;nbsp；列出本文件中用到的专门术语的定义和外文首字母组词的原词组。nbsp;nbsp;nbsp;1.4参考资料nbsp;nbsp;nbsp；列出用得着的参考资料，如：nbsp;nbsp;nbsp;a.本项目的经核准的计划任务书或合同、上级机关的批文；nbsp;nbsp;nbsp;b.属于本项目的其他已发表的文件；nbsp;nbsp;nbsp;C.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
以下nbsp；是我们单位的nbsp；项目开发计划书nbsp；希望对你有帮助编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度、nbsp；所需经费预算、所需软、硬件条件等问题作出的安排记载下来，以便根据本计划开展和检查本项目的开nbsp；发工作。
编制内容要求如下：nbsp;nbsp;nbsp;nbsp;1nbsp；引言nbsp;nbsp;nbsp;1.1编写目的nbsp;nbsp;nbsp;nbsp；说明编写这份项目开发计划的目的，并指出预期的读者。nbsp;nbsp;nbsp;1.2背景nbsp;nbsp;nbsp；说明：nbsp;nbsp;nbsp;a.待开发的软件系统的名称；nbsp;nbsp;nbsp;b.本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络；nbsp;nbsp;nbsp;C.该软件系统同其他系统或其他机构的基本的相互来往关系。
nbsp;nbsp;nbsp;1.3定义nbsp;nbsp;nbsp;nbsp；列出本文件中用到的专门术语的定义和外文首字母组词的原词组。nbsp;nbsp;nbsp;1.4参考资料nbsp;nbsp;nbsp；列出用得着的参考资料，如：nbsp;nbsp;nbsp;a.本项目的经核准的计划任务书或合同、上级机关的批文；nbsp;nbsp;nbsp;b.属于本项目的其他已发表的文件；nbsp;nbsp;nbsp;C.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
nbsp；列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。nbsp;nbsp;nbsp;2nbsp；项目概述nbsp;nbsp;nbsp;nbsp;2.1nbsp；工作内容nbsp;nbsp;nbsp；简要地说明在本项目的开发中须进行的各项主要工作。
nbsp;nbsp;nbsp;2.2主要参加人员nbsp;nbsp;nbsp；扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。nbsp;nbsp;nbsp;nbsp;2.3产品nbsp;nbsp;nbsp;2.3.1程序nbsp;nbsp;nbsp；列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。
nbsp;nbsp;nbsp;nbsp;2.3.2文件nbsp;nbsp;nbsp；列出需移交给用户的每种文件的名称及内容要点。nbsp;nbsp;nbsp;nbsp;2.3.3服务nbsp;nbsp;nbsp；列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持nbsp；的级别和服务的期限。
nbsp;nbsp;nbsp;2.3.4非移交的产品nbsp;nbsp;nbsp;nbsp；说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。nbsp;nbsp;nbsp;2.4验收标准nbsp;nbsp;nbsp;nbsp；对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。
nbsp;nbsp;nbsp;nbsp;2.5完成项目的员迟用限nbsp;nbsp;nbsp;nbsp;2.6本计划的批准者和批准日期nbsp;nbsp;nbsp;nbsp;3nbsp；实施计划nbsp;nbsp;nbsp;nbsp;3.1工作任务的分门与人员分工nbsp;nbsp；软件开发网nbsp;nbsp;nbsp；对于项目开发中需完成的各项工作，从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作，用户培训工作，软件安装工作等，按层次进行分解，指明每项任务的负责人和参加人员。nbsp;nbsp;nbsp;3.2nbsp；接口人员nbsp;nbsp;nbsp；说明负责接口工作的人员及他们的职责，包括：nbsp;nbsp;nbsp;anbsp；.负责本项目同用户的接口人员；nbsp;nbsp;nbsp;b.负责本项目同本单位各管理机构，如合同计划管理部门、财务部门、质量管理部门等的接口人员；nbsp;nbsp;nbsp;nbsp;c.负责本项目同各分合同负责单位的接口人员等。
nbsp;nbsp;nbsp;nbsp;3.3进度nbsp;nbsp;nbsp;nbsp；对于需求分析、设计、编码实现、测试、移交、培训和安装等工作，给出每项工作任务的预。定开始日期、完成日期及所需资源，规定各项工作任务完成的先后顺序以及表征每项工作任务完成的标志性事件（即所谓“里程碑“）。
nbsp;nbsp;nbsp;nbsp;3.4预算nbsp;nbsp;nbsp;nbsp；逐项列。
3. 电子开发文档怎么写
没写过，给你个范例。
开发文档范例一.需求规格说明书 1。引言 1）编写目的：阐明保险需求说明书的目的，指明读者对象。
2）项目背景：包括 a 项目的委托单位、开发单位和主管部门。 b 该软件系统与其他系统的关系。
3）定义：列出文档中所用到的专业术语的定义和缩写的原文。 4）参考资料：包括 a 项目经核准的计划任务书、合同或上级机关的批文。
b 项目开发计划。 c 文档所引用的资料、标准和规范。
列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。 2。
任务概述 1）目标。 2）运行环境。
3）条件与限制。 3。
数据描述 1）静态数据。 2）动态数据。
包括输入数据与输出数据。 3）数据库描述。
给出使用数据库的名称和类型。 4）数据词典。
5）数据采集。 4。
功能需求 1）功能划分。 2）功能描述。
5。性能需求 1）数据精确度。
2）时间特性。如响应时间、更新时间、数据转换与传输时间、运行时间等。
3）适应性。如操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时、应具有的适应能力。
6。运行需求 1）用户界面。
如屏幕格式、报表格式、彩单格式、输入输出时间等 2）硬件接口。 3）软件接口。
4）故障处理。 7。
其他需求 如可使用性、安全保密、可维护性、可移植性等。 二、概要设计说明书 1。
引言 1）编写目的：阐明保险需求说明书的目的，指明读者对象。 2）项目背景：包括 a 项目的委托单位、开发单位和主管部门。
b 该软件系统与其他系统的关系。 3）定义：列出文档中所用到的专业术语的定义和缩写的原意。
4）参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。可包括 a 项目经核准的计划任务书、合同或上级机关的批文。
b 项目开发计划。 c 需求规格说明书。
d 测试计划（初稿）e 用户操作手册（初稿）。f 文档所引用的资料、采用的标准和规范。
2。任务概述 1）目标。
2）运行环境。 3）需求概述。
4）条件与限制。 3。
总体设计 1）处理流程。 2）总体结构和模块外部设计。
3）功能分配。表明各项功能与程序结构的关系。
4。接口设计 1）外部接口。
包括用户接口、软件接口与硬件接口。 2）内部接口。
模块之间的接口。 5。
数据结构设计 1）逻辑结构设计。 2）物理结构设计。
3）数据结构与程序的关系。 6。
运行设计 1）运行模块的组合。 2）运行控制。
3）运行时间。 7。
出错处理设计 1）出错输出信息。 2）出错处理对策。
如设置任务、性能将级、恢复及再启动等。 8。
安全保密设计 9。维护设计 应说明为方便维护工作的设施。
如维护模块等。 三、详细设计说明书 1。
引言 1）编写目的：阐明编写概要设计说明书的目的，指明读者对象。 2）项目背景：应包括项目的来源和主管部门等。
3）定义：列出文档中使用到的专门术语和缩写词的愿意。 4）参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。
可包括 a 项目经核准的计划任务书、合同或上级机关的批文。b 项目开发计划。
c 需求规格说明书。d 测试计划（初稿）e 用户操作手册（初稿）。
f 文档所引用的资料、采用的标准和规范。 2。
总体设计 1）需求概述 2）软件结构：如给出软件系统的结构图。 3。
程序描述 逐个给出模块的以下说明： 1）功能。 2）性能。
3）输入项目。 4）输出项目。
5）算法：模块所选用的算法。 6）程序逻辑：详细描述模块实现的算法。
可采用：a.标准流程图 b.PDL语言 c.N-S图 d.PAD e.判定表与描述算法的图表。 7）接口。
8）存储分配。 9）限制条件。
10）测试要点：给出测试模块的主要测试要求。
4. 做软件项目设计文档怎么写啊
按照以下格式填就好了，不过是我自己写的，有不好的地方大家互相学习修改一下~
详细设计文档规范
1.0概述
这部分提供对整个设计文档的概述。描述了所有数据，结构，接口和软件构件级别的设计。
1.1 目标和对象
描述软件对象的所有目标。
1.2 陈述范围
软件描述。主要输入，过程功能，输出的描述，不考虑详细细节。
1.3 软件内容
软件被置于商业或者产品线中，讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。
1.4 主要系统参数
任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。
2.0 数据设计
描述所有数据结构包括内部变量，全局变量和临时数据结构。
2.1 内部软件数据结构
描述软件内部的构件之间的数据传输的结构。
2.2 全局数据结构
描述主要部分的数据结构。
2.3 临时数据结构
为临时应用而生成的文件的描述。
2.4 数据库描述
作为应用程序的一部分，描述数据库结构。
3.0 结构化和构件级别设计
描述程序结构。
3.1 程序结构
详细描述应用程序所选定的程序结构。
3.1.1 结构图
图形化描述结构。
3.1.2 选择性
讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。
3.2 构件描述
详细描述结构中的每个软件构件。
3.2.1 构件过程叙述（PSPEC）
描述构件的过程。
3.2.2 构件接口描述
详细描述构件的输入和输出。
3.2.3 构件执行细节
每个构件的详细演算描述。
3.2.3.1 接口描述
3.2.3.2 演算模型（e.g., PDL）
3.2.3.3 规范/限制
]3.2.3.4 本地数据结构
3.2.3.5 在3.2.3.6设计中包含的执行结果
3.3 软件接口描述
软件对外界的接口描述
3.3.1机器对外接口
与其他机器或者设备的接口描述。
3.3.2系统对外接口
对其它系统、产品和网络的接口描述。
3.3.3与人的接口
概述软件与任何人的界面。
4.0 用户界面设计
描述软件的用户界面设计。
4.1 描述用户界面
详细描述用户界面，包括屏幕显示图标、图片或者类型。
4.1.1 屏幕图片
从用户角度描述界面。
4.1.2 对象和操作
所有屏幕对象和操作的定义。
4.2 界面设计规范
用户界面的设计和实现的规范和标准。
4.3 可见构件
实现的GUI可见构件说明。
4.4 UIDS描述
用户界面开发系统描述。
5.0约束、限制和系统参数
会影响软件的规格说明、设计和实现的特殊事件。
6.0测试标准
测试策略和预备测试用例描述。
6.1 测试的类别
规定实施测试的类别，包括尽量详细的描述。这里是针对黑盒测试现象的描述。
6.2期待软件反馈
测试期待的结果描述。
6.3执行界线
特殊执行需要的说明。
6.4 重要构件确认
决定性构件或者需要特殊注意的构件的测试确认。
7.0附录
设计说明的补充信息。
7.1系统可跟踪矩阵
一个定期回归系统规格跟踪软件需求的矩阵。
7.2 产品战略
如果规格说明书是为一个产品设计的，描述相关的产品战略。
7.3 使用分析算法
描述所有分析活动所使用到的分析算法。
7.4 补充信息 （如果有需要特别说明的）
5. 如何书写Java项目的开发文档
我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。
人员流动是项目进行中比较让人头疼的事情。
做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。
比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。
6. 如何书写Java项目的开发文档
我现在公司是CMMI4认证的，最近我项目组在开始新产品，我负责了大部分文档编写。
人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。