软件开发的文档怎么写

1. 软件开发文档应该如何写 模块开发卷宗(GB8567——88)
1标题
软件系统名称和标识符
模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模块的功能标识代替模块名)
程序编制员签名
卷宗的修改文本序号
修改完成日期
卷宗序号(说明本卷宗在整个卷宗中的序号)
编排日期(说明整个卷宗最近的一次编排日期)
2模块开发情况表
3功能说明
扼要说明本模块(或本组模块)的功能,主要是输入、要求的处理、输出 。可以从系统设计说明书中摘录 。同时列出在软件需求说明书中对这些功能的说明的章、条、款 。
4设计说明
说明本模块(或本组模块)的设计考虑,包括:
a. 在系统设计说明书中有关对本模块(或本组模块)设计考虑的叙述,包括本模块在软件系统中所处的层次,它同其他模块的接口;
b. 在程序设计说明书中有关对本模块(或本组模块)的设计考虑,包括本模块的算法、处理流程、牵涉到的数据文卷设计限制、驱动方式和出错信息等;
c. 在编制目前已通过全部测试的源代码时实际使用的设计考虑 。
5原代码清单
要给出所产生的本模块(或本组模块)的第一份无语法错的源代码清单以及已通过全部测试的当前有效的源代码清单 。
【软件开发的文档怎么写】6测试说明
说明直接要经过本模块(或本组模块)的每一项测试,包括这些测试各自的标识符和编号、进行这些测试的目的、所用的配置和输入、预期的输出及实际的输出 。
7复审的结论
把实际测试的结果,同软件需求说明书、系统设计说明书、程序设计说明书中规定的要求进行比较和给出结论 。
2. 怎么写项目开发的文档 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 设计思路
通过相关技术,一一实现对管理员,站外,站内用户,公司新闻信息,商品信息进行实用的操作 。