用户登录
用户注册

分享至

如何写软件开发文档 软件开发文档应该如何写

  • 作者: 丨主宰
  • 来源: 51数据库
  • 2020-04-21

模块开发卷宗(GB8567——88)

1标题

软件系统名称和标识符

模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)

程序编制员签名

卷宗的修改文本序号

修改完成日期

卷宗序号(说明本卷宗在整个卷宗中的序号)

编排日期(说明整个卷宗最近的一次编排日期)

2模块开发情况表

3功能说明

扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出。可以从系统设计说明书中摘录。同时列出在软件需求说明书中对这些功能的说明的章、条、款。

4设计说明

说明本模块(或本组模块)的设计考虑,包括:

a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;

b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;

c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑。

5原代码清单

要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单。

6测试说明

说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出。

7复审的结论

把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论。

软件开发需要编写哪些文档?

这个问题没有一定的,因为这里有多种因素

如,开发阶段、文档化要求程度等,若是通过CMM评估的,文档就较多

一般的是按项目开发过程来分,基本的有

可行性研究报告(若是一个新项目且未确定的或应客户要求时需要,实际上大部份公司很少有这文档)

用户需求说明书(用户+开发人员共同确认)

软件需求规格说明书

设计说明书(体系结构、详细设计)

测试用例

用户手册

实现代码

这些文档中,包括一定的分析与设计图形,如用例图、数据库结构、ER图等

当然项目计划、测试计划也应算在内

其它的(如CMM要求的)

风险、估算方面的,质量保证方面的、配置管理方面、定义的模板、度量数据库等

具体需要多少文档就是要看项目实际

这方面的东西,可参考一些软件工程类的书

请问软件项目的技术开发文档都要写些什么呢,具体要求是什么呢,要写多少文档呢

要写的文档种类有很多;根据不同的软件系统,每种文档内容的内容、格式和要求又有所不同。

1)文档的种类可以参考任何一本《软件工程》书籍。大致包括:用户需求调研报告、需求分析、概要设计、用户手册、测试计划、详细设计、详细编码文档、测试报告等等

2)很多类型的软件文档都有国标(GB)或行业标准(例如国际军用标记——GJB)规定的格式,具体情况可查询相关标准。

软件开发文档怎么写

这要看你的文档是基于什么用途的销售用途:要有产品白皮书,产品未来方向报告,使用性能报告,兼容性报告,产品演示文稿说明设计用途的。产品功能需求文件,产品的底层设计,产品详细设计内容。产品用途的。产品目录,自诉文件,帮助文件,使用手册,产品授权书。客服用途。已知问题列表,常见问题解答,危机处理指南,问题诊断指南。有个模板可以看下国家标准软件开发文档模板GB856T http://www.cndzz.com/down/down.asp?id=65584&no=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. 简介:可以查看所有的论坛信息,并进行筛选,删除不健康、不文明留言

软件开发过程中需要写的文档?

http://wenku.baidu.com/view/8f2422d33186bceb19e8bbe2.html

根据你的问题,给你找了一份关于软件开发过程中所涉及到的文档,

更多软件开发知识,软件定制服务,可以到麦软软件了解

软件开发 怎么写文档 csdn

你把android sdk中的开发文档下载到本地,然后eclipse中就有javadoc显示了,你就能在代码里看到每个库函数的用法了。

书的话我建议买 精通Android2 ,或者 Android2高级编程 这两本书,讲解的细致,但是一定要结合sdk来看。国内的不要买。。。。(切身体会,千万别买)

看完之后就可以自己动手做做项目了。

对于java基础,我现在的感觉是 如果要深入学习android平台,java基础一定要好(里边包括各种java类库的用法,本地代码jni什么的)。但如果平时随便做做应用的话,会面向对象编程就完全可以了。

关于软件开发平台的介绍文档怎么写?

写软件的功能,您软件的应用价值呀?有什么吸引人的地方呀等等?凡事都是需要一点一滴积累起来的。

转载请注明出处51数据库 » 如何写软件开发文档 软件开发文档应该如何写

软件
前端设计
程序设计
Java相关