软件开发过程和文档

文档		执行人		详情
可行性分析报告		产品经理		项目的实现在技术上、经济上和社会因素上的可行性，可供选择的可能实施方案，实施方案的利弊。
项目开发计划		产品经理		实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
软件需求说明书（软件规格说明书）		产品经理		对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。这个文档一定要详细、明确，避免需求不明确，开发成本浪费。我是在这里掉了很多次坑。
概要设计说明书		开发人员		该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
详细设计说明书		开发人员		着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
用户操作手册		产品经理		本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
测试计划		测试QA人员		为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
测试分析报告		测试人员		测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。
开发进度月报		开发人员		该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
项目开发总结报告		产品经理		软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。
软件维护手册		开发人员		主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。
软件问题报告		测试人员		指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。
软件修改报告		开发人员		软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。     目前我们是通过一些管理网站，由测试人员发送bug，开发人员接受修复。禅道

一、开发过程和文档

软件开发一般包含如下阶段： 

需求分析、概要设计、详细设计的区别如下：

     1.需求分析——产生软件功能规格说明书，需要确定用户对软件的需求，要作到明确、无歧义，不涉及具体实现方法。用户能看得明白，开发人员也可据此进行下面的工作（概要设计）。 

     2.概要设计——产生软件概要设计说明书，说明系统模块划分、选择的技术路线等，整体说明软件的实现思路，并且指出关键技术难点等。

     3.详细设计-——产生软件详细设计说明书，对概要设计的进一步细化，一般由各部分的担当人员依据概要设计分别完成，然后再集成，是具体的实现细节。理论上要求可以照此编码。

1.1 需求分析 

需求分析阶段的任务是：在可行性分析的基础上，进一步了解、确定用户需求，准确地回答“系统必须做什么”的问题，涉及到软件系统的目标、软件系统提供的服务、软件系统的约束和软件系统运行的环境，输出需求规格说明书。

 

1.2 系统设计

按照自顶向下、逐层分解的设计方法，需依次完成总体架构设计、概要设计和详细设计。软件设计包括概要设计和详细设计。概要设计与详细设计是总分的关系，概要设计文档相当于机械设计中的装配图，而详细设计文档相当于机械设计中的零件图。

1.2.1 总体架构设计

总体架构设计是将系统作为整体的设计，对应系统需求。它包含软件设计、设备选型、网络、安全、性能等，侧重于描述产品的形态，方便技术人员（市场、客户）了解这个产品的功能。如系统是网络软件，可以描述产品及其他子系统在网络中的部署方式、交互方式等。

1.2.2 概要设计

概要设计就是分析软件系统的基本处理流程和组织结构；然后将系统依照功能（任务）的划分为不同模块，确定模块间调用关系和接口。

软件设计包括软件的运行（处理流程）设计、结构设计（划分功能模块，确定模块间的层次结构、调用关系和接口）、用户界面设计、数据库设计（存储什么数据，数据库选型、数据结构和关系）。常用的描述方式有：软件结构图、用例图、分层数据流图、数据字典以及相应的文字说明。

概要设计重点在功能描述，应该让读者大致了解系统作完后大体的结构和操作模式，为软件的详细设计提供基础。

概要设计内容如下：

 

1.2.3 详细设计

详细设计根据概要设计划分的模块任务和对外接口，设计出模块的算法、流程、状态转换等内容。

详细设计包括实现各模块的用户界面设计、算法设计、数据结构设计的细化（是一份完善的数据结构文档，包括类型、命名、精度、字段说明、表说明等内容的数据字典）等。常用的描述方式有：模块的流程图、状态图、局部变量及相应的文字说明等。

 详细设计则的重点在描述系统的实现方式，说明实现具体模块所涉及到的主要算法、数据结构、类的层次结构及调用关系、具体的方法函数和sql语句等。应当足够详细地说明各个层次中的每个模块（子程序）的设计考虑，以便根据详细设计进行编码和测试。

如果发现有结构调整（如分解出子模块等）的必要，必须返回到概要设计阶段，将调整反应到概要设计文档中。

详细设计内容如下: