软件开发公司的软件工程文档资料汇编文档格式.doc
《软件开发公司的软件工程文档资料汇编文档格式.doc》由会员分享，可在线阅读，更多相关《软件开发公司的软件工程文档资料汇编文档格式.doc（66页珍藏版）》请在冰点文库上搜索。
维护日期
维护纪要
V1.0
王大林
2001/01/03
—
V1.0.1
王小林
2001/02/10
网络版功能维护
2．项目概述及架构（ProjectSummaryandFramework）
2.1项目概述（ProjectSummary）
宏观上说明该项目是什么、能干什么、要求干得怎么样。
2.2项目架构（ProjectFramework）
宏观上描述该项目的架构：
单机结构、C/S结构、B/S结构。
并说明结构具体详细的运行平台：
硬件的要求、操作系统的要求、数据库管理系统的要求、对外接口的要求。
3．客户群分析（ClientAnalysis）
3.1客户群定位（ClientOrientation）
单机结构、C/S结构、B/S结构对应哪三种客户群，每种客户群的数量、素质、市场前景等。
3.2当前客户群分析（CurrentClientAnalysis）
当前客户群是指已签订合作协议或将要签订合作协议的客户群，分析他们的数量、素质、市场前景等。
3.3潜在客户群分析（LatencyClientAnalysis）
潜在客户群是指将来可能发展的客户群，分析他们的数量、素质、市场前景等。
4．项目功能（ProjectFunction）
4.1单机版功能（Stand-aloneFunction）
单机版功能，如表3-3所示。
表3-3单机版功能
编号
功能名称
功能描述
输入内容
输出内容
1
2
4.2网络版功能（NetworkFunction）
网络版功能，如表3-4所示。
表3-4网络版功能
4.3互联网络版功能（InternetFunction）
互联网络版功能，如表3-5所示。
表3-5互联网络版功能
5．项目性能（ProjectPerformance）
5.1响应时间（ResponseTime）
单机结构（包括主机多用户结构，即H/T结构）、C/S结构、B/S结构三种架构的终端数量，要求响应时间小于0.XX秒。
5.2处理速度（DisposalSpeed）
C/S结构、B/S结构两种架构的后台结算方式，结算速度分析。
5.3最大终端负载（TheHighestTerminalLoad）
C/S结构、B/S结构两种架构的并发处理最大终端（用户）负载数量分析。
以上性能要求，最好也用列表的形式给出。
6．项目接口（ProjectInterface）
6.1金融接口（FinanceInterface）
金融接口列表，如表3-6所示。
表3-6金融接口列表
接口名称
接口规范
接口标准
入口参数
出口参数
传输频率
6.2政府接口（GovernmentInterface）
政府接口列表，如表3-7所示。
表3-7政府接口列表
6.3互联网接口（InternetInterface）
互联网接口列表，如表3-8所示。
表3-8互联网接口列表
7．投入产出分析（AnalysisoftheDevotionandtheOutput）
7.1人力资源投入（ManpowerDevotion）
人力资源投入，如表3-9所示。
表3-9人力资源投入
阶段名称
需求岗位
需求人数
工作量（人/月）
到岗日期
需求分析
分析师
概要设计
设计师
详细设计
设计师/高级程序员
编码
程序员
测试
测试员
包装与发布
包装师
总人数：
总工作量（人/月）：
7.2设备资源投入（FacilityDevotion）
设备资源投入，如表3-10所示。
表3-10设备资源投入
设备名称
规格型号
数量
单价（元）
金额（元）
到位日期
7.3其他经费资源投入（OtherOutlayDevotion）
其他经费资源投入，如表3-11所示。
表3-11其他经费资源投入
开支项目
开支金额（元）
支付日期
支付方式（现金/支票）
备注
项目总投入（人力费用+设备费用+其他经费资源投入）经费（元）：
7.4产出分析（OutputAnalysis）
产出分析，如表3-12所示。
表3-12产出分析
单机版单价（元）
单机版
C/S版单价（元）
C/S版数量
B/S版单价（元）
B/S版数量
年产出合计金额（元）
第1年
第2年
第3年
8．开发计划（DevelopmentScheme）
8.1进度计划（PlanScheme）
开发进度计划，如表3-13所示。
表3-13进度计划
第1周进度
第2周进度
第3周进度
第4周进度
第5周进度
……
8.2评审计划（ReviewScheme）
各里程碑的评审计划，如表3-14所示。
表3-14评审计划
评审日期
评审地点
主持人
参加人
应交文档
测试报告
包装
9．案例分析（CasesAnalysis）
案例分析包括成功案例和失败案例分析。
9.1国外案例分析（CasesAnalysisinForeignCountries）
案例1：
案例2：
9.2国内案例分析（CasesAnalysisinChina）
10．风险分析（RiskAnalysis）
10.1需求风险（RiskofRequirement）
指项目组对用户需求获取的途径和能力有何风险，用户主动配合需求的程度。
10.2政策风险（RiskofPolicy）
指国家政策、行业政策、企业内部政策的变化对项目将会产生有利或不利的影响。
10.3资源风险（RiskofResource）
指开发和运行所需资源的风险程度。
10.4技术风险（RiskofTechnology）
指项目组采用新技术的风险程度。
如最新开发工具的风险程度、最新设计思想的风险程度。
10.5技能风险（RiskofSkill）
指项目组成员掌握新技术的风险程度。
2《软件项目投标书》
表3-15《软件项目投标书》编写参考指南
序号
章节名称
章节内容
项目概况
按照招标书的内容，陈述项目概况
总体解决方案
按照招标书的要求，提出项目的总体解决方案：
网络结构总体方案
系统软件配置方案
应用软件设计方案
系统实施方案
3
项目功能、性能和接口描述
应用软件的具体功能点列表
应用软件的具体性能点列表
应用软件的具体接口列表
续表
4
项目工期、进度和经费估算
项目工期（单位：
人月）估算
项目进度估算：
需求、设计、编程、测试、验收的时间表
项目经费（单位：
人民币元）估算
5
项目质量管理控制
质量标准
质量管理控制方法
项目开发和管理的组织结构及人员配备
6
附录
附录1：
本软件公司的特点与强项简介
附录2：
本软件公司的成功案例
附录3：
本软件公司的资质证明材料
3《软件产品开发任务书》
《软件产品开发任务书》正文样本
任务书名称：
大型商业MIS产品开发任务书。
下达日期：
1999/04/01。
发出部门：
XX公司研发中心。
接受部门：
研发中心商业软件部。
1．目标
（1）做成商业MIS产品，其产品化程度要求很高。
因此，一切信息都要规范化、标准化、代码化。
保证在产品实施时，其客户化工作只需录入代码和修改代码，绝对不允许修改数据结构和表结构；
（2）配合市场销售部门、全国各地的分支机构和产品代理商，第一年开拓市场3~5个客户，第二年占领10%的商业MIS市场。
2．功能模块划分及要求
大型商业MIS软件产品拟分为以下6个功能模块，要求每个功能模块具有高内聚、低耦合、信息隐蔽的性质，如表3-16所示。
表3-16大型商业MIS产品的6个功能模块
模块名称
功能要求
商业物流配送中心管理
商业物流采购、配送
大型商场（大型连锁超市）管理
商品零售
便利店（小型连锁超市）管理
远程数据交换管理
点对点通信
电子商务模块
网上订货、销售
商业类库管理
基础类库、商业类库、构件库管理
3．功能模块详述
大型商业MIS软件，从组织结构上来说包括三个层次：
（1）物流配送中心
（2）大型商场（大型连锁超市）
（3）便利店（小型连锁超市）
作为一个完整的商业MIS系统来说，物流配送中心与大型商场（大型连锁超市）之间会发生物流、资金流、信息流的关系；
大型商场（大型连锁超市）与便利店（小型连锁超市）之间也会发生物流、资金流、信息流的关系；
而物流配送中心与便利店（小型连锁超市）之间没有任何关联。
若将这三个模块分开来看，它们又可以各自独立成为一个单独的小型商业系统来使用。
实际上，本大型商业MIS系统完成后，可以对功能模块进行组合或拆分，使其成为如下5个不同的小型商业MIS系统，供用户选择：
（1）物流配送中心＋大型商场（大型连锁超市）＋便利店（小型连锁超市）的完整的商业MIS软件。
（2）物流配送中心＋大型商场（大型连锁超市）的商业MIS软件。
（3）大型商场（大型连锁超市）＋便利店（小型连锁超市）的商业MIS系统。
（4）物流配送中心MIS系统。
（5）大型商场的商业MIS系统。
作为本软件的第一层，物流配送中心可以具有多个配送仓库，它根据大型商场（大型连锁超市）的需要以及各个仓库库存情况，向供应商订货，进行货物采购；
并根据订货的情况进行配货，组织运输工具进行发货；
期间，还伴随着向供应商付款、索取发票，以及向客户催款、开出发票等等。
大型商场（大型连锁超市）作为本软件的第二层，除了要进行本商场的各种业务管理外，还要向上级物流配送中心订货、付款、索取发票，向下级便利店（小型连锁超市）送货，收取钱款等等。
便利店（小型连锁超市）作为本软件的第三层，一要进行本商场的各种业务管理；
二要根据库存情况，向大型商场（大型连锁超市）要货，并定期将销售金额上交给大型商场（大型连锁超市）。
考虑到目前有些商场，已经有了其他的商业管理软件，虽然软件还有不完善的地方，但已经购买前台POS机。
为了给客户节省开支，有效地将前台POS机利用好，所以，本系统的前台销售软件就要做两个版本：
Windows版本与DOS版本。
由于配送中心与大型商场（大型连锁超市）之间、大型商场（大型连锁超市）与便利店（小型连锁超市）之间在物理位置上有一定的距离，所以，它们之间的网络连接也是一个需要重视的大问题。
本系统考虑采用两种解决方案：
一是采用DDN专线（或光缆），本方案数据传输速度快，性能高，程序设计、实现都很简单，但用户每月都要支付价格不低的线路费用，这种方案比较适合那些经济实力比较雄厚的用户；
二是采用电话线，用X.25通信协议，此方案数据传输速度稍慢，但也能满足用户需要，程序设计和实现要复杂许多，用户每月支付的线路费用将大幅度下降。
随着计算机网络技术的飞速发展，电子商务在流通领域的应用也越来越多。
本MIS系统也准备在电子商务方面有所扩展，条件允许，可以实现网上订货、网上销售，甚至网上货币支付。
作为一个软件企业，应该不断地提取、积累自己的软件资源。
不同开发平台的开发规范、商业类库、应用框架、构件、中间件等都是十分重要的软件资源，是软件公司的基础建设。
因此，在设计、编码之前，要制订相应的开发规范，要组织开发、设计、管理一些类库和构件库。
软件产品是软件公司的财富来源，而软件的有效加密是保护公司产品、产权的有效手段，更是保障公司效益的有效途径。
所以，还要考虑软件加密算法设计。
4．功能模块任务分配
根据研发中心商业软件部目前的人员情况，本系统的项目经理由商业软件部副经理亲自担任，负责整个系统的规划、设计、协调与实施；
商业软件部主任工程师担任产品经理，负责项目的整体需求、数据库设计与Alpha测试。
整个项目分为4个任务组，各个任务组组长在项目实施阶段，承担小项目经理职责。
4个任务组的人数及开发任务，如表3-17所示。
表3-17任务组的人数及开发任务
任务组
人数
具体开发任务
第1任务组
1）POS机模块改造
2）利用X.25协议进行远程数据交换
3）电子商务模块
第2任务组
物流配送中心管理模块。
本模块的主要功能包括：
货物的采购管理，配送中心的库存管理，货物的销售管理三大部分
1）货物的采购管理包括：
供应商管理，采购计划管理，订货管理，货物验收管理，退货管理，应付账款管理，应收发票管理，往来账管理等
2）库存管理包括：
货位管理，入库管理，出库管理，盘库管理等
3）销售管理包括：
客户管理，销售定单管理，配货管理，运输工具管理，发货管理，退货管理，应收账款管理，应付发票管理，往来账管理等
第3任务组
1）全局数据库设计
2）商业管理模块（包括大型商场与便利店的管理）。
货物的采购管理，退货管理（退给供应商），价格管理，库存管理，销售管理，前台销售管理，退货管理（客户退货管理），应付、应收账款管理，发票管理，送货管理（给便利店送货），收款管理（便利店上交金额）等等
第4任务组
1）PowerBuilder开发规范
2）PowerBuilder类库建设
3）构件的提取和构件库的管理
4）产品的加密处理
5）安装盘的制作
5．数据库与开发工具的选择
考虑到数据库的性能与价格比，数据库首选Sybase，其次是MSSQLServer。
由于这两个数据库的天然联系，使得两个版本的程序设计的差异将十分微小。
数据库设计工具采用PowerDesigner，程序开发工具选择为PowerBuilder。
某些PowerBuilder不宜实现的功能，可由VC++去完成。
文档制作工具为Office和PowerDesigner。
6．开发进度计划
研发中心商业软件部现有18人进入了本项目组。
根据以往的实际工作经验，下面列出研发进度，如表3-18所示。
表3-18进度计划（1999/04/01-1999/10/15）
发布
需求培训
需求获取
需求确认
第6周进度
第7周进度
第8周进度
第9周进度
第10周进度
第11周进度
第12周进度
第13周进度
第14周进度
第15周进度
第16周进度
第17周进度
第18周进度
第19周进度
第20周进度
Alpha测试
第21周进度
第22周进度
第23周进度
第24周进度
Beta测试
第25周进度
第26周进度
第27周进度
第28周进度
机动
7．评审计划
各里程碑的评审计划，如表3-19所示。
表3-19里程碑评审计划
1999/05/05
公司第一会议室
部门经理
项目组成员
用户需求报告/需求规格说明书
1999/05/26
概要设计说明书
1999/06/25
项目经理
详细设计说明书
1999/09/12
测试人员
Alpha测试报告
1999/09/26
客户单位
客户代表
Beta测试报告
1999/09/31
销售人员
包装光盘，用户指南，广告材料
附件：
《商业MIS立项建议书》，此处省略。
4《软件开发计划书》
《软件开发计划书》编写参考指南
本章提供整个软件开发计划的综述。
主要是确定以下内容：
（1）软件生存周期的选取及裁剪。
（2）软件规范、方法和标准的选择。
（3）软件工作产品的规模估计。
（4）软件工作量和成本的估计。
（5）软件进度表的制定。
（6）软件风险的估计。
（7）软件项目培训计划。
说明该软件开发计划的范围，简要描述软件开发计划的内容。
一般而言，对于一个较大的软件项目（工期6个人月以上），计划书包括如下内容：
（1）软件规模估计
（2）工作模块计划
（3）人力资源计划
（4）其他资源计划
（5）进度安排计划
（6）配置管理计划（可单独做一个计划）
（7）质量保证计划（可单独做一个计划）
将该软件开发计划中的术语、缩写词进行定义。
包括用户应用领域与计算机领域的术语与缩写词等。
例如：
[1]软件相关组：
指软件配置管理组、文档支持组、测试组。
[2]软件质量保证组：
指计划和实施软件质量保证活动的人员的集合。
说明该软件开发计划使用的参考资料，如项目的用户需求报告、商务合同、用户领域的资料等，每一个文件、文献要有标题、索引号或文件号，发布或发表日期以及出版单位。
当该文档变更时，可能对其他文档产生影响，受影响的文档叫相关文档，需将它们列出。
版本更新记录格式，如表4-8所示。
表4-8版本更新记录
2001/02/06
2001/02/25
成本估算维护
2．项目概述（ProjectSummary）
2.1项目的目的（ProjectPurpose）
说明该软件项目的目的。
2.2项目的范围（ProjectScope）
本章的内容，主要参照《立项建议书》/《合同》与《用户需求报告》中相关章节，简要描述该软件项目的实现范围：
（1）主要功能点列表
（2）主要性能点列表
（3）主要接口列表
（4）本软件项目与其他软件项目之间的关系
（5）项目实施方面的限制等内容
2.3项目的
升级会员 