云计算学习/云计算1+x/云计算学习手册/第一章，工程项目文档编写

第一章 工程项目文档编写

1.1 引言

现在很多企业业务开展都离不开项目管理，项目文档管理，是指在一个项目运行过程中将提交的各类文档进行收集管理控制的过程。工程项目保存的文档要涵盖项目可研、总体设计、基础设计、详细设计等整个项目周期，其中包括项目系统管理、文档版本控制、文档质量管理等管理内容。项目经理可以从项目文档角度去把握项目进展情况。因此，工程项目文档对于一个项目的顺利进行有着至关重要的作用，其关键性不容忽视。

本章节主要介绍工程项目的整个开发过程，以及工程项目的各种规范文档。使学生能够了解工程项目的背景，掌握工程项目的整个开发过程，能读懂各种工程项目文档，会填写工程项目文档。学生工程项目文档学习路线图如图1-1所示。

图1 工程项目文档学习路线图

1.2 项目流程概述

每个项目大致要经过调研项目、项目立项启动、项目计划、需求分析、需求变更、系统设计、构建开发、测试验收、部署试运行上线和项目总结的不同阶段。如图1-1-1所示展示了整个项目开发的流程。

 

图1-1-1 项目流程

1.3 项目角色介绍

项目成员角色可以分为项目经理、产品经理、开发经理、测试经理。

l 项目经理为整个项目的核心，推动项目的整个进行，保证项目的交付。

l 产品经理主要负责设计项目需求，需求必须符合客户的需要。

l 开发经理主要进行软件设计以及代码实现，顺利的实现项目的要求。

l 测试经理主要负责对项目的质量进行审查，确保项目质量达到预期目标。

1.4 项目流程介绍

1.项目立项

主要由项目经理组织项目人员进行项目启动会议，明确项目背景、需要实现哪些功能、项目交付时间等，其主要目的是要项目组成员明确项目的情况。

2.项目计划

由项目经理牵头各角色成员配合，制定项目的开发计划、项目的里程碑、风险计划、上线计划、验收计划等。其主要目的是为了让项目能够准时交付，各过程可控。

3.需求阶段

由产品经理根据项目的情况进行需求分析，整理出详细的需求内容，包括需求规格说明书、产品设计图、产品原型图、产品高清设计图等。项目需求在整个项目开发过程中十分重要。

4.设计阶段

在需求阶段之后即详细的需求已经确认，由开发经理组织相关的开发团队进行研发设计，该阶段分为概要设计和详细设计阶段。先对项目的实现进行概要设计，即设计系统的总体框架以及使用到的技术评估。概要设计完成后，由开发经理组织相关的项目成员进行技术评审会议，技术评审通过后方可进行详细设计，即详细的代码逻辑设计。 

5.开发阶段

在项目需求以及项目设计完成的情况下，由开发经理分配各开发成员的任务，由每个开发人员进行代码开发实现。在开发实现过程中，各开发成员要进行代码版本控制。确保代码和系统版本可控。

6.测试阶段

当项目功能实现后，且开发团队已经自己测试无大问题后，就可以提交测试团队进行最终的项目质量验证。验证的过程是一个迭代的过程，测试人员针对开发团队发布的内部测试版本，针对项目需求逐一认证，发现有问题的，则通过项目管理系统进行发布，开发人员进行问题解决，测试人员进行回归测试验证。（白盒代码，黑功能）

7.试运行上线

当项目功能实现，且测试团队无发现重大问题，达到可以上线的标准后。则由开发经理负责部署正式的上线系统，并且试运行一段时间。如果在试运行期间发现严重问题，则还需要进行问题修改，修改后再次进行试运行上线。

当项目试运行过程中发现无重大问题，满足上线标准时，则项目正式上线运行，进行客户交付。

8.项目总结

当项目进行试运行上线交付后，项目经理必须召集所有项目团队成员进行项目总结会议，项目总结项目的得与失，吸取项目经验。项目文档及代码在项目的每个阶段都需要进行编写，下方会有详细的模板以及编写的要求，项目总结会议完成后，项目所有的资料，包括项目代码、项目文档、软件及硬件资料都要及时归档到公司项目库中。

下面就以某银行系统容器云平台建议的项目实战案例进行介绍。

注意：以下案例如果和事实有雷同，纯属巧合。

1.5 实战案例——某银行系统上容器云平台项目

1.5.1 案例目标

（1）掌握项目开发流程。

（2）掌握项目立项、项目计划、项目需求、系统设计、开发编码、测试、项目上线结项过程。

1.5.2 案例分析

通过某银行系统上容器云平台项目，让读者了解项目的整个开发过程。从项目立项到项目计划、项目需求、系统设计、开发编码实现、系统测试、项目上线结项整个过程。

1.5.3 案例实施

1.项目立项 

（1）项目背景

随着互联网金融的兴起，互联网企业依托互联网，特别是移动互联网为公众提供越来越多方便快捷、稳定高效的金融类服务，对传统的银行业务带来了很大冲击。作为应对，传统银行也在业务上不断创新，带来对IT基础设施和应用架构方面进行转型升级的要求。例如为了支撑电商促销活动对银行带来的高峰期海量支付请求，某银行很早就对支付渠道相关业务应用进行微服务架构改造，由此带来了容器技术的研究和运用。此银行的多年实践证明，采用容器技术平台很好地支撑了新的业务模式和业务容量。

基于业务发展的需要和快速进步的金融科技技术，越来越多的传统银行在思考自身的互联网金融战略、金融云规划等。其中重要内容之一，是希望从技术层面更有效地支持业务创新，如微服务架构、更好的灵活性、扩展性、高可用性、更高效的业务上线效率等，因此跟上云计算技术发展的趋势，建设并推广适合自身的基于容器技术的云平台是关键任务。

由此本公司承担某地区某银行系统上容器云平台。

（2）项目立项

项目由项目经理A总负责，组成一个项目团队，并且在半年内实现银行系统上容器云平台，并进行两年系统维护，确保银行系统正常运行。某银行系统和公司签定项目合同，约定项目周期以及项目金额等条款。

（3）项目团队成立

项目团队由项目经理A负责，召集相关的人员组成该项目团队。

项目成员有项目经理A、产品经理A、产品人员A、开发经理A、开发人员A、开发人员B、测试经理A、测试人员A、测试人员B。

项目成员由以上人员组成，各成员备份各自的承接任务的能力以及达到技术要求。项目成员各自承担项目任务，可以参照上方的项目流程。

（4）项目立项工具（Microsoft Office Word）

Microsoft Office Word是微软公司的一个文字处理器应用程序。Word给用户提供了用于创建专业而优雅的文档工具，帮助用户节省时间，并得到优雅美观的结果。一直以来，Microsoft Office Word都是最流行的文字处理程序。

作为Office套件的核心程序，Word提供了许多易于使用的文档创建工具，同时也提供了丰富的功能集供创建复杂的文档使用。哪怕只使用Word应用一点文本格式化操作或图片处理，也可以使简单的文档变得比只使用纯文本更具吸引力。

该软件可以在网上自行下载安装，下面以Microsoft Office Word 2010版本为例，如图1-5-1所示：

图1-5-1 Microsoft Office Word 2010版本

Word下载安装好后，双击打开该应用程序，打开后的界面如图1-5-2所示，会新建一个word文档。

图1-5-2 新建一个word文档

此时就可以开始编辑文字，输入所想要表达的内容。

①选择“开始”菜单命令，如图1-5-3所示：

图1-5-3 开始菜单

可以进行简单的文字输入，对文字进行设置格式、大小、颜色、正文、标题等。这是最常用的选项卡。具体用法可以参照Word软件系统帮助。

②选择“插入”菜单命令，如图1-5-4所示：

图1-5-4 插入菜单

可以进行插入封面、分页、图片、形状图形、图表、链接等内容，并且可以对文档添加页眉、页脚、艺术字等。具体用法可以参照Word软件系统帮助。

③选择“页面布局”菜单命令，如图1-5-5所示：

图1-5-5 页面布局菜单

可以对文档的文字颜色、字体、文字方向，文档页边距，页面边框等内容进行设置。具体用法可以参照Word软件系统帮助。

④选择“引用”菜单命令，如图1-5-6所示：

图1-5-6引用菜单命令

 可以对文档添加目录、插入脚注、插入引文、插入题注等功能，常用的功能是插入目录。具体用法可以参照Word软件系统帮助。

⑤选择“邮件”菜单命令，如图1-5-7所示：

图1-5-7 邮件菜单命令

可以进行批量发送邮件，设置邮件格式。此选项卡不常用，作为了解即可。具体用法可以参照Word软件系统帮助。

⑥选择“审阅”菜单命令，如图1-5-8所示：

图1-5-8 审阅菜单命令

可以对文档进行拼写检查、字数统计、文档批注、文档修订等功能。具体用法可以参照Word软件系统帮助。

⑦选择“视图”菜单命令，如图1-5-9所示：

图1-5-9 视图菜单命令

可以对文档查看的视图进行调整，文档编辑标尺、多窗口排列等。

项目中的文档需要Word软件来进行编制，这部分需要掌握牢固，特别是对于简单的文字和图片的编辑，其它高级功能可以了解。

（5）项目立项文档

项目启动阶段，将项目的目标、规划与任务进行完整的定义和阐述、形成一份完整的项目工作任务书，作为项目立项的关键产出。任务书等可以通过Microsoft Office Word软件来进行编辑，参照上方的用法。

①《用户需求说明书》简要探讨在与客户交流、查阅业务资料等一系列需求获取和分析工作后，及时整理用户需求并建立需求文档。主要说明见附录1《用户需求说明书》。

《用户需求说明书》按照模板进行编写用户需求，主要是项目经理和客户沟通后编写的用户需求说明书，此项目中主要描写银行现有系统已经不