来源 :http://www.miiceic.org.cn 2008-1-28 14:47:46
中程在线<script language="javascript" type="text/javascript" src="http://www.miiceic.org.cn/function/GetHits.asp?InfoID=13470&amp;type=1"></script> 浏览数:4
如今,
软件开发越来越复杂,
软件功能也越来越丰富。而几乎所有成熟的商业软件,都是靠一个开发
团队齐心协力的血汗结晶。“罗马不是一天建成的!”,当我们震撼于
Microsoft Windows的惊世巨著的同时,也道听途说了
微软公司
软件工程是如何的完善规范。 的确,集数百名员工几年的共同努力之大成,
软件项目管理的成败是控制开发成本的关键环节。这里面,少不了贯穿其中的重要步骤——
软件文档。
软件文档可以分为开发文档和产品文档两大类。
开发文档包括:《功能要求》、《投标方案》、《需求分析》、技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。
产品文档包括:《产品简介》、《产品菔尽贰ⅰ兑晌式獯稹贰ⅰ豆δ芙樯堋贰?技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、 《用户报告》、《销售培训》等。
一、开发文档
1. 《功能要求》--来源于客户要求和市场调查,是软件开发中最早期的一个环节。客户提出一个模糊的功能概念,或者要求解决一个实际问题,或者参照同类软件的 一个功能。有软件经验的客户还会提供比较详细的技术规范书,把他们的要求全部列表书写在文档中,必要时加以图表解说。这份文档是需求分析的基础。
2. 《投标方案》--根据用户的功能要求,经过与招标方沟通和确认,技术人员开始书写《投标方案》,方案书一般包括以下几个重要的章节:
前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。
需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。
技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。
项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。
技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。
系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。
项目进度--整个项目的进度计划,包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。
3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础,进行详细的功能分析(包括客户提出的 要求和根据开发经验建议的功能),列出本产品是什么,有什么特殊的概念,包括那些功能分类,需要具备什么功能,该功能的操作如何,实现的时候该注意什么细 节,客户有什么要求,系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。
4. 技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、 技术升级方向、技术方案评价,竞争对手技术分析等。以《需求分析》为基础,进行详细的技术分析(产品的性能和实现方法),列出本项目需要使用什么技术方 案,为什么,有哪些技术问题要解决 ,估计开发期间会碰到什么困难,技术方案以后如何升级,对本项目的技术有什么评价等。
5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础,进行详细的系统分析(产品的开发和实现方法),估计开发期间需要把什么问题说明白,程序员根据《系统分析》,开始在项目主管的带领下进行编码。
6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础,进行详细的数据库设计。必要时可以用图表解说,特别是关系数据库。
7. 《功能函数文档》--包括变量名、变量初植、功能,函数名,参数,如何调用、备注、注意事项等。以《系统分析》为基础,进行详细的说明,列出哪个功能涉及多少个函数,以便以后程序员修改、接手和扩展。
8. 《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求,这里与软件完成后的运行界面是一致的。
9. 《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。
10. 《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等,提供给软件测试人员使用。
11. 《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。
二、产品文档
1. 《产品简介》--包括公司背景、产品概念、适用范围、产品功能、功能特点、运行要求和公司联系地址。
2. 《产品演示》--包括公司简介、产品背景、产品描述、产品特点、产品作用、适用范围、使用分析、功能模块、解决问题、合作伙伴、成功案例等。一般用Powerpoint或者VCD录制软件实现。
3. 《疑问解答》--列出用户关心的问题和处理方法。用于解答软件的操作功能和解决用户的疑难问题。
4. 《功能介绍》--以《需求分析》为书写基础,包括软件介绍、软件结构、功能列表、功能描述和公司联系地址。
5. 技术白皮书》--以技术分析》为书写基础,包括功能实现、技术选型、关键技术问题的解决、技术方案特点、技术升级方向等。
6. 《评测报告》--第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。
7. 《安装手册》--包括系统环境、运行平台、产品安装过程、初始环境设置、安装记录等。
8. 《使用手册》--包括产品简介、功能列表、功能描述和解释、功能操作、客户服务和联系方式等。
9. 《维护手册》--包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技术问题解答和联系方式等。
10. 《用户报告》--包括产品简介、购买时间、使用目的、使用时间、使用地点、实施过程、出现问题和解决、产品总结和建议等。
11.《销售培训》--包括项目简介、产品功能、产品特点、商业优势、系统运行环境、适用范围、目标客户等。
分享到:
相关推荐
文档的分类和等级,文档管理的原则和方法,文档示例与讨论。
2021最新产品需求模板系列-软件开发文档范例.doc 本文档提供了一份软件开发文档的范例,介绍了一个免费电子邮件系统的设计和开发过程。该系统的主要目标是满足不断增长的信息交换需求,提供一个高度集成、功能强大...
开发文档 软件需求(规格)说明书 数据要求说明书 概要设计说明书 详细设计说明书 可行性研究报告 项目开发计划 管理文档 项目开发计划 测试计划 测试报告 开发进度月报 开发总结报告 ...
软件开发文档范例 本文档是关于软件开发的文档范例,旨在提供一个电子系统的设计和开发指南。文档中主要介绍了系统的设计目标、功能和技术架构,并对系统的可行性进行了分析。 系统设计目标 系统的设计目标是立足...
软件管理控制分为三个方面:软件开发项目分类、软件项目管理分类和软件项目各阶段管理。 软件开发项目分类将软件项目分为三类:软件产品项目、内部管理软件项目和内部工具软件项目。软件项目管理分类包括正式立项...
在项目文档分类表中,我们可以看到文档用途的详细信息,如项目管理、软件开发、软件测试等。这项技术可以帮助项目团队更好地理解文档的用途和应用场景。 在文档用途中,我们需要考虑到文档的应用场景、文档的受众、...
文件自动分类作为文件处理的一个不可忽视的环节现在越来越被人们所重视,我和我的小组为了使文件进行快速、高效、 准确的自动分类,决定开发一款新的文件自动分类软件。 文件分类是指根据文件的内容和属性,将文件归...
本文档是一个软件项目开发需求文档,旨在开发一个图书租售管理系统。该系统需要包括图书出租、还租、出售、退售、内阅、预订、会员管理、积分管理、简单的财务系统、详细分类统计、多种模式查询、短信平台、各数据...
导言.IT项目的生命期 第一章.IT项目的启动阶段 1.1 可行性研究报告框架 1.2 项目章程 1.3 项目整体风险水平定性分析表 1.4 多项目风险情况一览表 1.5 质量保证说明书 1.6 采购程序及准购权限表 .........
6.2文件的分类与标识 7 6•3文件的控制 7 6.4文件的修改管理 8 7 可行性研究报告 9 8 项目开发计划 10 9 软件需求说明书 11 10 数据要求说明书 12 11 概要设计说明书 12 12详细设计说明书 13 13 数据库设计说明书 ...
<br>软件工程标准化 软件工程的七条基本原理 软件工程标准化的意义 我国的软件工程标准化工作 软件工程控制的重要性 软件工程标准的层次 软件开发 <br>软件文档的作用和分类 文档编制...
非常全名,包括14分文档,包括有 可行性研究报告模版、详细设计说明书模版、程序维护手册模版、软件修改报告模版、软件问题报告模版、项目开发总结报告模版、需求规格说明书模版、测试计划模版、用户操作手册模版、...
在软件开发的评定中,软件开发人员将软件相关文档和源程序交于软件测试小组,软件测试小组根据《软件测试规范》进行测试,并填写《软件测试问题汇总表》作为软件开发质量的评定标准。然后,对每一位开发人员开发质量...
● 文档所引用的资料、软件开发的标准或规范。 2 总体设计 2.1 需求概述 2.2 软件结构:如给出软件系统的结构图。 3 程序描述 3.1 逐个模块给出以下说明: ● 功能 ● 性能 ● 输入项目 ● 输出...
本书讲述了软件开发中一个至关重要的问题—软件需求问题。软件开发人员及用户往往容易忽略信息沟通,导致软件开发出来后,不能很好地满足用户的需要。而返工则不仅在技术上给开发人员带来巨大的麻烦,而且软件性能...
拓欣电子文档管理系统是一个注重细节和客户体验的系统软件,完全可以满足中小企业和个人对电子文档的管理需求,同时也可根据客户的个性化需求在该平台基础上进行二次开发。 功能特点: 树型目录结构,目录提供索引...
软件工程在软件开发中的运用 作者:张佳晨 来源:《数字技术与应用》2019年第11期 摘要:随着时代的进步,经济水平大幅度改善,出现各种各样的新兴产业,这 加快了社会可持续发展。如互联网想持续增长,必须依靠最...
对于写毕业论文的同学有用 ...2.1软件文档的作用及分类 2 2.2软件文档所采用的标准 2 2.3 软件文档的主要内容 3 第3章 实 例 5 3.1 软件需求实例 5 3.2 开发计划实例 11 第4章 实训日记 17 第5章 实训总结 18
通过流程驱动,软件开发团队可以更好地管理项目状态,记录和追踪需求、产品、文档、流程的变更过程,提高开发效率和质量。 需求管理是软件开发的重要组成部分,需求管理工具可以帮助团队成员更好地定义、分析和跟踪...
软件工程与教育软件开发的思考 作者:王丽莎 来源:《中国教育信息化·高教职教》2008年第03期 摘 要:如今,教育软件的开发不但要讲求教学质量,而且应该如工程软件一样在开发前做 必要的需求分析和成本估算。...