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. 电子开发文档怎么写
没写过,给你个范例。
开发文档范例一.需求规格说明书 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)测试要点:给出测试模块的主要测试要求。
3. 网站开发文档怎么写
网站前期调查阶段
文档1:《前期调查分析报告》主要内容可以是,进行了什么样的调查;调查的对象;调查的覆盖率;调查的结果。这个结果得出的结论,和一些建设性意见。
确定网站主题阶段
文档2:《网站CI形象报告》主要内容主题定位、网站命名、网站标志、标准色彩、标准字体、宣传标语
文档3:《网站目标设计说明书》对网站目标的一个详细说明,其中包括初期目标、中期目标和最终目标。
确定网站内容和阶段
文档4:《网站访问者来源报告》描述网站的服务对象(文化层次,兴趣爱好,上网条件),估计对象在整个网民中所占的比率。它是《网站功能分析说明书》的一部分。
文档5:《网站功能分析说明书》可以描述以下的问题,为什么人们会来你的网站;你的网站有什么特色的服务吗;你们第一次来你的网站原因;有什么可以吸引他们在来的吗?
文档6:《内容和功能清单》明确网站需要什么内容,需要什么功能。使用目标清单、访问者的需求和竞争性分析这些已经收集的所有信息,开始做两个新的清单:一个是网站的内容要素,一个是网站的功能。为每个清单增加仍和潜在的页面或内容的类型。内容的类型包括静态的、动态的、功能的和事物处理的。浏览竞争对手的网站,把他们有而你没有的内容和功能加入你的清单。当你建立这两个清单是,让每个人建他们自己的清单,然后把这些清单合并在一起。让每个人检查一遍合并后的清单,确定清单中每个条目的重要性。如果有必要的话,修订你的清单。
文档7:《可视化目录文件清单》
文档8:《网站层次结构图》
4. 软件开发文档应该如何写
模块开发卷宗(GB8567——88)
1标题
软件系统名称和标识符
模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号(说明本卷宗在整个卷宗中的序号)
编排日期(说明整个卷宗最近的一次编排日期)
2模块开发情况表
3功能说明
扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。
4设计说明
说明本模块(或本组模块)的设计考虑,包括:
a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;
b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;
c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。
5原代码清单
要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。
6测试说明
说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。
7复审的结论
把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。