项目管理——软件文档分类简介

如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎所有成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的!”，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。的确，集数百名员工几年的共同努力之大成，软件项目管理的成败是控制开发成本的关键环节。这里面，少不了贯穿其中的重要步骤----软件文档。

　　软件文档可以分为开发文档和产品文档两大类。

　　开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA文档》、《项目总结》等。

　　产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》、《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。

　　一、开发文档

　　1. 《功能要求》--来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。

　　2. 《投标方案》--根据用户的功能要求，经过与招标方沟通和确认，技术人员开始书写《投标方案》，方案书一般包括以下几个重要的章节：

　　前言--项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。

　　需求分析--项目要求、软件结构、功能列表、功能描述、注意事项等。

　　技术方案--总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。

　　项目管理--描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。

　　技术支持--公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。

　　系统报价--软、硬件平台报价列表、软件开发费用、系统维护费用等。

　　项目进度--整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。

　　3. 《需求分析》--包括产品概述、主要概念、操作流程、功能列表和解说、注意事项、系统环境等。以《功能要求》为基础，进行详细的功能分析(包括客户提出的要求和根据开发经验建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。

　　4. 《技术分析》--包括技术选型、技术比较、开发人员、关键技术问题的解决、技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析(产品的性能和实现方法)，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。

　　5. 《系统分析》--包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析 (产品的开发和实现方法)，估计开发期间需要把什么问题说明白，程序员根据《系统分析》，开始在项目主管的带领下进行编码。

　　6. 《数据库文档》--包括数据库名称、表名、字段名、字段类型、字段说明、备注、字段数值计算公式等。以《系统分析》为基础，进行详细的数据库设计。必要时可以用图表解说，特别是关系数据库。

　　7. 《功能函数文档》--包括变量名、变量初植、功能，函数名，参数，如何调用、备注、注意事项等。以《系统分析》为基础，进行详细的说明，列出哪个功能涉及多少个函数，以便以后程序员修改、接手和扩展。

　　8. 《界面文档》--包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运行界面是一致的。

　　9. 《编译手册》--包括服务器编译环境、操作系统、编译工具、GNU的C++编译器版本信息、目录说明、程序生成、源程序文件列表、Makefile配置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译示例、编译环境、操作系统、编译工具、源文件列表和制作安装程序的过程。

　　10. 《QA文档》--包括产品简介、产品原理、产品功能列表、功能描述、功能流程、执行结果、数据库结构、测试要求等，提供给软件测试人员使用。

　　11. 《项目总结》--包括项目简介、项目参与人员和开发时间、项目风险管理过程、项目功能列表、项目结构特点、技术特点、对项目的升级建议、对以后的项目的建议、人员素质情况等。

项目管理——软件文档分类简介相关推荐

ESD静电保护器件分类简介及场景应用
文章目录 1. ESD介绍 1.1 ESD简介 1.2 ESD产生原理 1.3 ESD危害 2. 器件级ESD模型 2.1 人体模型(HBM) 2.2 机器模型(MM) 2.3 带电器件模型(CDM) ...
3D点云形状分类简介
3D点云形状分类简介 3D形状分类主要有三种方法:基于多视图的(multi-view),基于体积的(volumetric-based),基于点的(point-based). 基于多视图的方法将非结构化 ...
ASP.NET服务器控件分类简介
ASP.NET服务器控件分类简介 ASP.NET服务器控件服务器控件就是在服务器端解析的控件,在ASP.NET中,就是有runat=server的控件,这些控件经处理后会生成客户端呈现代码发送到客户 ...
【数据挖掘】K-NN 分类 ( 简介 | 分类概念 | K-NN 分类实例 | K-NN 分类准确度评估 | K-NN 分类结果评价指标 | 准确率 | 召回率 )
文章目录 I . K-NN 简介 II . K-NN 分类 III . K-NN 分类实例 IV . K-NN 分类准确性评估方法 V . 保持法 VI . kkk-交叉确认法 VII . K-NN ...
GIT项目管理工具(part1)--简介及概念
本系列BLOG为鄙人学习GIT时的学习笔记.前一个知识点引出后一个知识点,后一个例子接着前一个例子. 文章目录 GIT简介基本概念导航系列文章目录 GIT简介什么是GIT(项目管理工具) gi ...
唐中印项目管理实战专家简介
唐中印: 讲师简介 n 职称:(工信部)高级项目管理师.PMP.信息系统监理师 n 全国计算机技术与软件专业技术资格(水平)考试用书编委会委员 n 全国计算机技术与软件专业技术资格(水平)考试继续教育 ...
企业系统软件分类简介
企业在运行的过程中,需要很多的辅助软件,来支持企业的正常运转和加快企业的运行速度等,那么企业在有哪些软件需要呢? 1.企业的基础管理软件-OA OA的中文意思是办公自动化,是英文Office Auto ...
nlp-tutorial代码注释2-1，CNN用于句子分类简介
本部分基于paper:Convolutional Neural Networks for Sentence Classification 模型介绍目的模型的目的是对输入的句子进行分类.论文中的模型 ...
MATLAB实现支持向量机SVM分类简介
1. 支持向量机SVM 支持向量机(SVM, support vector machine)是名噪一时的机器学习方法,自20世纪末以来在模式识别领域风生水起,至今仍然活跃在各大论文期刊中.无论是和其他 ...

项目管理——软件文档分类简介

项目管理——软件文档分类简介相关推荐

最新文章

热门文章