IT项目管理人员必备的软件文档知识

1、.：.；软件文档知多少？如今，软件开发越来越复杂，软件功能也越来越丰富。而几乎一切成熟的商业软件，都是靠一个开发团队齐心协力的血汗结晶。“罗马不是一天建成的！，当我们震撼于Microsoft Windows的惊世巨著的同时，也道听途说了微软公司软件工程是如何的完善规范。确实，集数百名员工几年的共同努力之大成，软件工程管理的成败是控制开发本钱的关键环节。这里面，少不了贯穿其中的重要步骤-软件文档。 软件文档可以分为开发文档和产品文档两大类。开发文档包括：、等。 产品文档包括：、等。 一、开发文档 1. -来源于客户要求和市场调查，是软件开发中最早期的一个环节。客户提出一个模糊的功能概念，或者要求

2、处理一个实践问题，或者参照同类软件的一个功能。有软件阅历的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表讲解。这份文档是需求分析的根底。 2. -根据用户的功能要求，经过与招标方沟通和确认，技术人员开场书写，方案书普通包括以下几个重要的章节： 前言-工程背景、公司背景和业务、技术人员构造、公司的胜利案例引见等。 需求分析-工程要求、软件构造、功能列表、功能描画、本卷须知等。 技术方案-总体要求和指点思想、技术处理方案、软件开发平台、网络构造体系等。 工程管理-描画公司的软件开发流程、工程实施效力、组织和人员分工、开发进度控制、软件质量保证、工程验收和人员培训

3、、软件资料文档等。 技术支持-公司的技术支持和效力引见、效力目的和目的、效力级别和呼应时间、技术效力区域、技术效力期限、授权用户联络人等。系统报价-软、硬件平台报价列表、软件开发费用、系统维护费用等。工程进度-整个工程的进度方案，包括签署合同、工程启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。3. -包括产品概述、主要概念、操作流程、功能列表和讲解、本卷须知、系统环境等。以为根底，进展详细的功能分析(包括客户提出的要求和根据开发阅历建议的功能)，列出本产品是什么，有什么特殊的概念，包括那些功能分类，需求具备什么功能，该功能的操作如何，实现的时候该留

4、意什么细节，客户有什么要求，系统运转环境的要求等。这里的功能描画跟以后的运用手册是一致的。4. -包括技术选型、技术比较、开发人员、关键技术问题的处理、技术风险、技术晋级方向、技术方案评价，竞争对手技术分析等。以为根底，进展详细的技术分析(产品的性能和实现方法)，列出本工程需求运用什么技术方案，为什么，有哪些技术问题要处理，估计开发期间会碰到什么困难，技术方案以后如何晋级，对本工程的技术有什么评价等。5. -包括功能实现、模块组成、功能流程图、函数接口、数据字典、软件开发需求思索的各种问题等。以为根底，进展详细的系统分析(产品的开发和实现方法)，估计开发期间需求把什么问题阐明白，程序员根据，开

5、场在工程主管的带着下进展编码。 6. -包括数据库称号、表名、字段名、字段类型、字段阐明、备注、字段数值计算公式等。以为根底，进展详细的数据库设计。必要时可以用图表讲解，特别是关系数据库。7. -包括变量名、变量初植、功能，函数名，参数，如何调用、备注、本卷须知等。以为根底，进展详细的阐明，列出哪个功能涉及多少个函数，以便以后程序员修正、接手和扩展。8. -包括软件外观、界面素材、编辑工具、文件名、菜单、按钮和其它界面部件的要求，这里与软件完成后的运转界面是一致的。9. -包括效力器编译环境、操作系统、编译工具、GNU的C+编译器版本信息、目录阐明、程序生成、源程序文件列表、Makefile配

6、置及其相关程序的对应关系列表。客户端的编译过程、编译结果、编译例如、编译环境、操作系统、编译工具、源文件列表和制造安装程序的过程。10. -包括产品简介、产品原理、产品功能列表、功能描画、功能流程、执行结果、数据库构造、测试要求等，提供应软件测试人员运用。11. -包括工程简介、工程参与人员和开发时间、工程风险管理过程、工程功能列表、工程构造特点、技术特点、对工程的晋级建议、对以后的工程的建议、人员素质情况等。二、产品文档 1. -包括公司背景、产品概念、适用范围、产品功能、功能特点、运转要求和公司。 2. -包括公司简介、产品背景、产品描画、产品特点、产品作用、适用范围、运用分析、功能模块、

7、处理问题、协作同伴、胜利案例等。普通用Power point或者VCD录制软件实现。 3. -列出用户关怀的问题和处置方法。用于解答软件的操作功能和处理用户的疑问问题。 4. -以为书写根底，包括软件引见、软件构造、功能列表、功能描画和公司。 5. -以为书写根底，包括功能实现、技术选型、关键技术问题的处理、技术方案特点、技术晋级方向等。 6. -第三方权威评测报告。包括评测目的、评测范围、评测环境、评测内容、实测数据、性能表现、结果分析和评测总结等。 7. -包括系统环境、运转平台、产品安装过程、初始环境设置、安装记录等。 8. -包括产品简介、功能列表、功能描画和解释、功能操作、客户效力和联络方式等。 9. -包括产品简介、系统须知、初始环境设置、系统配置、数据管理和备份、技