软件工程
软件设计的整体流程
- 软件需求分析阶段:输出了《软件需求规格说明书》,不涉及具体实现方法。用户能看得明白,开发人员也可据此进行下面的工作,搞清楚“要解决什么问题”。
- 概要设计阶段:确定软件系统的总体布局,各个子模块的功能和模块间的关系,与外部系统的关系,选择的技术路线。有一些研究与论证性的内容。并输出《软件概要设计说明书》。搞清楚“总体实现方案”
- 详细设计阶段:对概要设计的进一步细化,一般由各部分的担当人员依据概要设计分别完成,然后在集成,是具体的实现细节。是“程序”的蓝图,确定每个模块采用的算法、数据结构、接口的实现、属性、参数。并输出《软件详细设计说明书》。搞清楚“每个模块怎么做”
- 概要设计说明书侧重说明相关系统结构、业务流程、系统功能;
- 详细设计说明书侧重说明相关系统代码结构、解释代码相关属性、简述与各类功能程序有关的数据情况;
- 数据库设计说明书侧重说明系统中的所有数据类型、定义、属性等情况以及数据之间的关联情况。
需求分析
需求分析也称为软件需求分析、系统需求分析或需求分析工程等,是开发人员经过深入细致的调研和分析,准确理解用户和项目的功能、性能、可靠性等具体要求,将用户非形式的需求表述转化为完整的需求定义,从而确定系统必须做什么的过程。 简单理解就是要搞清楚问题域,问题域就是用户的需求,软件要为用户解决什么问题,实现哪些业务功能,满足什么样的性能要求。
如何作需求分析?
- 首先确认用户需求
用户需求即用户的原始需求。通过用户访谈、问卷调查、开会讨论、查阅资料等调研手段梳理用户的原始需求。产品人员根据用户需求会绘制界面原型,通过界面原型再和用户确认需求。 2. 确认关键问题
用户的原始需求可能是含糊不清的,需求分析要从繁杂的问题中梳理出关键问题。比如:教学机构的老师想要将课程发布到网上,这是原始需求,根据这个用户需求我们需要进行扩展分析,扩展出几下几点:
- 课程发布需要发布哪些信息
- 如果发布了不良信息怎么办?
- 课程发布后用户怎么查看课程? 根据以上几点继续延伸性分析:
- 课程发布需要发布哪些信息 课程名称、课程介绍、课程价格、课程图片、师资等信息 继续延伸分析: 这么多课程信息进行归类,方便用户编辑,分为课程基本信息、课程营销信息、课程师资等信息。 按照这样的思路对用户需求逐项分析,梳理出若干问题,再从中找到关键问题。比如:上边对课程信息分类后,哪些是关键信息,课程名称、课程图片、课程介绍等基本信息为关键信息,所以发布课程的第一步要编写课程基本信息。找到了关键问题,下一步就可以进行数据建模,创建课程基本信息表,并设计其中的字段。
- 梳理业务流程
业务流程是由一个或多个用户参与完成为了完成一个目标所进行的一系列的业务操作,不论是整个系统还是一个模块通常首先分析核心的业务流程,比如:内容管理模块的核心业务流程是课程发布,本项目的核心业务流程是学生选课学习流程。 4. 数据建模
数据建模要根据分析的关键问题将其相关的信息全部建模。比如:根据发布课程的用户需求,可创建课程基本信息表、课程营销信息表、课程师资表、课程发布记录表、课程审核记录表等。 5. 编写需求规格说明书
需求分析阶段的成果物是需求分析规格说明书,针对每一个问题编写需求用例,需求用例包括:功能名称、功能描述、参与者、基本事件流程、可选事件流、数据描述、前置条件、后置条件等内容。 比如:添加课程的需求用例如下:
我们为什么需要《软件需求规格说明书》 ?
如果需求的编写只是为了解释说明软件实现的功能,那么良好的编码结构,代码注释就可以很好的实现软件的功能说明,程序员可以将编写需求的时间节约下来进行更多功能的实现; 可是,这样的情况可能更多适用于中小型项目,或者互联网项目,因为这样的项目需求不复杂,并且需求变化很快,所以研发的效率非常重要。然而,针对大型软件项目或者功能比较复杂的系统,软件研发可能是多人协作的成果,所以在信息传递过程中, 我们只有提前考虑好软件需求的内容,才能正确评估开发软件所需要的时间,成本的要素,从而更好的管理项目。
《软件需求规格说明书》的一般结构
- 正文的第一章内容是1.概述,包含 1.1.编写目的;1.2.术语与定义;1.3.参考资料;三个部分
- 第二章要给出该项目的标准和规范,在文档的后续内容编写中以及项目开发过程中必须遵照这个标准和规范进行。
- 第三章应该说明该项目的相关假设、限制和一些依赖条件,在后续系统部署的过程中可以有参考意义。
- 第四章“功能规格”是重点,重点介绍这个系统的角色,界面设计思路,系统的功能视图和功能点清单,以及系统的需求用例。这个内容必须详细描述,这样才能对后续的开发和测试提供指导意义。
- 第五章“非功能规格”要对项目的性能、安全、数据的备份恢复等内容解释说明,一个项目除了功能完整之外,还要考虑性能、安全等相应的要求。
- 第六章“附录”,是对软件需求规格说明书的一些补充说明文档,其中的“软件需求跟踪矩阵”是重点,这份文档是对后续需求的完善程度进行了严格的控制。
概要设计
《概要设计说明书》的一般结构
总述:需求或目标(讲一下事情的起源)、环境、局限;
总体设计:从全局的角度说一下 组织结构、功能、处理流程、有哪些模块、模块间的关系,运行环境等。(输出图:系统结构图,系统流程图,数据流程图,推荐在线画图工具https://www.processon.com/) (opens new window)
外部接口:总体说明外部用户、软、硬件接口(可用资源);
模块设计:每个模块“做什么”、简要说明“怎么做”(输入、输出、处理逻辑、与其它模块或系统的接口),处在什么逻辑位置、物理位置。
- 模块描述:说明哪些模块实现了哪些功能;
- 模块层次结构:可以使用某个视角的软件框架图来表达;
- 模块间的关系:模块间依赖关系的描述,通信机制描述;
- 模块的核心接口:说明模块传递的信息、信息的结构;
- 处理方式设计:说一些满足功能和性能的算法;
数据结构:逻辑结构、物理结构。
容灾设计:出错信息、出错处理。(可选)
监控设计:运行模块组合、控制、时间。(可选)
用户界面设计:(可选)。
安全设计:(可选)。
其它设计:(可选)。
制定规范(附录): 设计原则,代码规范、接口规约、命名规则。
概要设计需要注意的地方
- 用来评价总体设计的可行性。
- 用来检查设计的模块是否完整,保证每一个功能都有对应的模块来实现。
- 用来评估开发工作量、指导开发计划(在不写详细设计的情况下)。
- 概要设计阶段过于重视业务流程是个误区.
- 概要设计阶段过于重视细节实现是个误区.
详细设计
《详细设计说明书》的一般结构:
参考如何撰写软件详细设计内容? (opens new window)
引言,包含: 编写目的,背景,参考资料,术语定义及说明
设计概述,包含:任务和目标,需求概述,运行环境概述, 条件与限制,详细设计方法和工具
系统详细需求分析,包含:详细需求分析,详细系统运行环境及限制条件分析接口需求分析
总体方案确认,包含: 系统总体结构确认, 系统详细界面划分
系统详细设计,包含: 系统结构设计及子系统划分,系统功能模块详细设计(采用HIPO图进行功能分解与模块描述,,用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系,以及需求、功能和模块三者之间的交叉参照关系。), 系统界面详细设计
数据库系统设计
详细设计需要注意的地方
如果有或者有必要,特别是大型的软件系统,详细设计阶段划分系统功能模块或子系统。
概要设计和详细设计的区别
概要设计阶段
在这个阶段,设计者会大致考虑并照顾模块的内部实现,但不过多纠缠于此。主要集中于划分模块、分配任务、定义调用关系。模块间的接口与传参在这个阶段要定得十分细致明确,应编写严谨的数据字典 (opens new window),避免后续设计产生不解或误解。概要设计一般不是一次就能做到位,而是反复地进行结构调整。典型的调整是合并功能重复的模块,或者进一步分解出可以复用的模块。在概要设计阶段,应最大限度地提取可以重用的模块,建立合理的结构体系,节省后续环节的工作量。
概要设计文档最重要的部分是分层数据流图、结构图、数据字典以及相应的文字说明等。以概要设计文档为依据,各个模块的详细设计就可以并行展开了。
详细设计阶段
在这个阶段,各个模块可以分给不同的人去并行设计。在详细设计阶段,设计者的工作对象是一个模块,根据概要设计赋予的局部任务和对外接口,设计并表达出模块的算法、流程、状态转换等内容。这里要注意,如果发现有结构调整(如分解出子模块等)的必要,必须返回到概要设计阶段,将调整反应到概要设计文档中,而不能就地解决,不打招呼。
详细设计文档最重要的部分是模块的流程图、状态图、局部变量及相应的文字说明等。
参考文章
软件需求规格说明书模板 (opens new window) 软件概要设计-模板 (opens new window) 软件概要设计做什么,怎么做 (opens new window) 互联网公司研发RD如何撰写总体设计与详细设计文档 (opens new window) 项目开发过程中详细设计和概要设计有什么区别和要求? (opens new window) 如何撰写软件详细设计内容? (opens new window)