东辰安华知识网 大家好，关于什么是开发文档很多朋友都还不太明白，今天小编就来为大家分享关于什么是软件开发文档的知识，希望对各位有所帮助！
本文目录
开发文档怎么写
1.1.1项目名称
项目名称（项目类型）
1.1.2项目开发者
成员一：**
成员二：***
成员三：***
1.1.3项目开发环境
MyEclipse＋Tomcat5.5和MyEclipse（自带）＋SQLServer2005
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.名称：新闻模块
jdk开发文档是干嘛的
JDK是SUN公司提供的一套Java开发环境，其中包含Java编译器、Java运行工具、Java文档生成工具、以及Java打包工具。
在JDK的bin目录下存放了很多可执行文件，其中最重要的就是java.exe和javac.exe、举例说明：
?正常我们编写好程序存放在源文件a.java中，之后会通过javac.exe（Java编译器工具）进行编译，编译完成后会生成a.class文件（字节码文件，是可执行的java程序），
?然后接下来java.exe（Java运行工具）会启动JVM（Java虚拟机）进程，Java虚拟机相当于一个小型的操作系统，它专门负责运行由Java编译器生成的字节码文件（a.class），从而使程序运行。
软件项目开发文档包括的内容有哪些
在软件项目开发过程中，应该按软件开发要求撰写十三类文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性！需求阶段
1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。设计阶段
4、概要设计说明书该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。开发阶段
6、开发进度月报该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。测试阶段
7、测试计划为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
8、测试分析报告测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。收尾阶段
9、用户操作手册本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
10、项目开发总结报告软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。
11、软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。维护阶段
12、软件问题报告指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。
13、软件修改报告软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。
什么是软件开发文档
在软件的生产过程中，总是伴随着大量的信息要记录、要使用。因此，软件文档在产品的开发生产过程中起着重要的作用。
1)提高软件开发过程的能见度。把开发过程中发生的事件以某种可阅读的形式记录在文档中。管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。
2)提高开发效率。软件文档的编制，使得开发人员对各个阶段的工作都进行周密思考、全盘权衡、从而减少返工。并且可在开发早期发现错误和不一致性，便于及时加以纠正。
3)作为开发人员在一定阶段的工作成果和结束标志。
4)记录开发过程中的有关信息，便于协调以后的软件、开发、使用和维护。
5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解。使软件开发活动更科学、更有成效。
6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。文档在各类人员、计算机之间的多种桥梁作用中看出：既然软件已经从手工艺人的开发方式发展到工业化的生产方式，文档在开发过程中就起到关键作用。从某种意义上来说，文档是软件开发规范的体现和指南。按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。PS：软件开发文档包括：操作手册维护修改建议软件需求（规格）说明书开发文档软件需求（规格）说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划管理文档项目开发计划测试计划测试报告开发进度月报开发总结报告
好了，本文到此结束，如果可以帮助到大家，还望关注本站哦！
