项目文档怎么写
发布者：王龙2020-03-17
1.怎么写项目开发的文档
软件开发中文档的编写是一个不可缺少的环节，常见的如《需求分析》、《概要分析》、《数据库设计》等。在“软件人”的阵营里向来存在两种观点，注重文档还是关心代码。
我这里写一个《用户信息模块的概要设计文档》，只列举主要内容了
1.功能描述：用于完成系统用户信息的新增、删除、修改、查询；
2.功能用例：一个主用例用户信息，附加新增、删除、修改、查询4个子用例，操作人员为管理员，图形就不画了，很简单的；
3.业务流程：查询有效范围用户信息——》新增用户信息——》判断当前帐号是否存在——》存在给出提示，反之保存成功提示。
4.约束限制：超级管理员可操作所有（包含删除，我这里考虑仅是逻辑删除、非物理删除）的用户信息；系统管理员可操作除系统管理员、超级管理员外的全部用户信息；单位管理员可操作本单位用户信息；用户帐号信息系统内全局唯一；
5.系统性能：要求同时支持500个并发操作；页面操作响应时间小于1s；页面大小小于1kb;
当前用户所属员工信息不存在时，可直接进行员工信息的添加，并完成用户信息的同步保存，确保事务的完整性；
6.运行环境：依赖系统整体运行环境为准（存在特殊需要注明）；
7.操作实体：用户信息、员工信息、系统日志等。
8.异常处理：如果系统框架中已经提供相关说明，这里仅需要注明符合系统架构异常处理方式即可。
9.外部接口：输入—用户ID，输出—用户信息；
10.其他说明：用户帐号必须定义为字母开头，数字与字母组合，并保证全局唯一；用户密码采用md5算法加密，系统架构已提供相关接口。
11.注意事项：用户帐号不能为空，不能存在空格，不能超过6位；超级用户信息仅在系统初始化中完成其信息写入操作，其他用户无权对其进行修改。
项目组中也不是所有人都必须参与文档的编写，通常业务需求人员、设计人员、架构师、项目经理、小组长占大多数，而且这些人中很多也不是专注于写代码的角色。
2.怎么写项目开发的文档
1.1.1 项目名称项目名称（项目类型）1.1.2 项目开发者成员一：**成员二：***成员三：***1.1.3 项目开发环境MyEclipse + Tomcat5.5和MyEclipse（自带）+ SQLServer 20051.1.4 系统功能设定品红商业网分为2大模块： 1.前台系统 ## 设定新闻，商品以及购物相关功能： NEWS：对新闻的增加、删除和查询操作，并且增加上下条功能进行查询，以及最新新闻的显示与增加。
PRODUCT：对商品的增加、删除、修改和查询操作，并且增加分页技术进行查询，以及最新商品的展示与增加；增设对商品的选购，打印清单、结算功能。 TALKING：用户之间的在线聊天，进行互动交流，洽谈业务，对信息发表自己的看法等，并设有广告介绍，让用户了解最新信息。
MESSAGE：客户留言薄，针对各种商情，业务交流进行离线留言，站外，站内用户可以通过此信息及时了解最新资讯，了解用户反馈信息等。 about：介绍了公司对客户的信心，诚意做出了诚恳的表态。
AFTER：介绍了公司关于商品的售后服务条例等，给客户提供更满意的服务。 COPYRIGHT：介绍了公司的版权信息，以及法律授权及其相关。
2.后台管理系统 ## 设定对管理员，用户以及管理员对新闻和商品信息的相关操作。 ADMIN：对用户的查询和删除，对新闻的增加，删除和查询，对商品的增加、删除、修改和查询，都增设了分页技术更有规范的查询。
并附有时间，让操作人员在任何时候都能得到精准时间，以提高管理员的时间观念。 1.1.5 项目开发技术JSP + Javascript + HTML1.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. 简介：可以查看所有的论坛信息，并进行筛选，删除不健康、不文明留言。
3.怎么写项目需求文档
系统流程描述
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. 简介：可以查看所有的论坛信息，并进行筛选，删除不健康、不文明留言
============================================================================
希望能给你 解决1
4.java 项目需求文档要怎么写
需求文档一般分两类
需求调研报告
需求分析报告
调研报告：是记录的用户的原始需求，基本上可以算做是和用户沟通的原始记录。
分析报告：是对调研报告进行归类分析的结果。一个比较全面的文档了，在这个文档里面一般包含以下内容：
项目的背景
项目的目标
项目的范围
用户特点
相关技术、规范标准等
相关约束
用户的组织结构、角色等
用户需要的功能点，这些功能的优先级，业务流程、功能特点，有没有特殊需求等等
总而言之，需求分析报告的下一站是给设计人员的，设计人员看到需求分析报告就知道系统应该包含哪些功能点、权限设计、流程设计等，这些内容都可以直接从需要分析报告里面得出
5.做软件项目设计文档怎么写啊
按照以下格式填就好了，不过是我自己写的，有不好的地方大家互相学习修改一下~ 详细设计文档规范 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 补充信息 （如果有需要特别说明的）。
6.软件项目的测试文档如何写
目前没有经典的定义。比较通常的说法是：指对一项特定的软件产品进行测试任务的描述，体现测试方案、方法、技术和策略。内容包括测试目标、测试环境、输入数据、测试步骤、预期结果、测试脚本等，并形成文档。
不同类别的软件，测试用例是不同的。不同于诸如系统、工具、控制、游戏软件，管理软件的用户需求更加不统一，变化更大、更快。笔者主要从事企业管理软件的测试。因此我们的做法是把测试数据和测试脚本从测试用例中划分出来。测试用例更趋于是针对软件产品的功能、业务规则和业务处理所设计的测试方案。对软件的每个特定功能或运行操作路径的测试构成了一个个测试用例。
随着中国软件业的日益壮大和逐步走向成熟，软件测试也在不断发展。从最初的由软件编程人员兼职测试到软件公司组建独立专职测试部门。测试工作也从简单测试演变为包括：编制测试计划、编写测试用例、准备测试数据、编写测试脚本、实施测试、测试评估等多项内容的正规测试。测试方式则由单纯手工测试发展为手工、自动兼之，并有向第三方专业测试公司发展的趋势。
要使最终用户对软件感到满意，最有力的举措就是对最终用户的期望加以明确阐述，以便对这些期望进行核实并确认其有效性。测试用例反映了要核实的需求。然而，核实这些需求可能通过不同的方式并由不同的测试员来实施。例如，执行软件以便验证它的功能和性能，这项操作可能由某个测试员采用自动测试技术来实现；计算机系统的关机步骤可通过手工测试和观察来完成；不过，市场占有率和销售数据（以及产品需求），只能通过评测产品和竞争销售数据来完成。
既然可能无法（或不必负责）核实所有的需求，那么是否能为测试挑选最适合或最关键的需求则关系到项目的成败。选中要核实的需求将是对成本、风险和对该需求进行核实的必要性这三者权衡考虑的结果
7.电子开发文档怎么写
没写过，给你个范例。
开发文档范例一.需求规格说明书 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）测试要点：给出测试模块的主要测试要求。
