当前位置:首页 » 网页前端 » 前端架构开发文档怎么写
扩展阅读
webinf下怎么引入js 2023-08-31 21:54:13
堡垒机怎么打开web 2023-08-31 21:54:11

前端架构开发文档怎么写

发布时间: 2023-08-08 11:52:51

㈠ 什么是前端架构

架构设计的最重要目的是为了进行整体系统概览,以及开发方向指导。
而架构要包含的内容,简单说就是下面四个
1、系统间关系
2、系统内关系
3、应用内架构
4、系统规范与原则
而架构的原则主要是三个方面
1、架构的合适:架构就像衣服,不能太长,也不能太短
2、可扩展的:架构需要充分考虑扩展性
3、持续不断的:架构不是一次性物品,是一个跟着软件生命周期的长期过程

㈡ 如何写好项目方案设计文档

事实上,撰写项目规划和设计文档,最重要的不是文档的模版和格式,而是里面的具体内容,它往往需要结合实际客观环境因素来综合考虑,平衡取舍,是一个需要充分脑力活动的工作。尽管如此,在大多数情况下,还是有一些相对通用的指导原则可以帮助我们更好的完成这项工作。

首先,需要有明确项目背景,目标,以及核心需求分析

换句话说,就是这个项目从产品或业务的角度,最核心的推动力是什么?再换句话说,痛点是什么?

有痛点自然就有目标,你希望项目最终以什么方式解决问题,能达成什么目标。

背景和目标的阐述,必须要能够自然合理的推导出下一部分内容:项目的核心需求/功能是什么。

如果项目背景,目标的描述不能起到这个作用,那这一节内容就没写好,因为项目方案文档就缺乏了根本的出发点,后续的内容都没有了好坏对错判断的基本依据。

举个例子,如果我想构建一个数据交换服务或ETL系统,那么上述各环节的内容可能是(简化的写):

背景 : 当前数据ETL链路极端难用,效率低下,稳定性差,维护代价高,用户抱怨多等等。
目标 : 用户全自助,简单易用;可维护性好;性能高;可靠性好。
核心需求 : 比如针对“用户全自助,简单易用”这点(其它目标可以类似分析推理),可能是:
提供统一的,标准化的配置后台:用配置的形式表达ETL业务语意,屏蔽下层实现细节。
提供完善的错误反馈信息/机制:让用户能自助解决使用中遇到的问题。
ETL业务流程标准化:将最佳实践沉淀下来,通过配置的方式让用户选择,减少重复工作,降低用户开发的难度,规避使用姿势错误可能造成的问题。

其次,需要对现状和问题进行充分的收集和分析

从方案文档的角度来说,放在这悉弊里,是为了进一步细化问题,分析目标,核心需求与当前现状的差距在哪里,具体有哪些实际问题需要解决。为后续具体的实现方案,准备必要的输入信息,确定工作的优先级,重要性,项目迭代的步骤等等。

需要强调的是,现状和问题分析,要围绕前面的核心需求的条目展开,两者是强关联的,不要相互脱节,各讲各的

最后,是输出解决方案
定完需求目标,分析完问题和现状,接下来才是规划具体做什么,怎么做,什么时候做

做什么:
做什么和前面项目目标的要求刚好截然相反,需要输出明确的可执行的事项,而不是模糊的不可执行的要求。
具体做的每一件事情,都要和前面的核心需求和现状问题对应上。如果你发现有些工作,和前面的目标没有任何关联性,那么考虑一下目标是否需要再评估调整,或者这件事情根本就是不重要的。
要做的事项列表,是一个经过归纳思考以后的总结,而不只是一个个零散的事情的随机列表。需要有重点和优先级。如果有必要,以归类,分组等形式结构化的组织相关联的事项。
完整的事项列表,应该是一个和最终目标对应的完整解决方案,而不仅仅只是完成目标工作中的某一个环节。
比如面向用户的终端产品项目,需要包括整个产品的交互逻辑,业务流程的规范设计等等,而不指肆仅仅是对底层系统实现和后台功能点的设计。
这点很多同学也很容易忽略,总觉得功能和架构的实现才是有挑战,需要规划的内容,而产品的形态并没有花心思去琢磨,事后开发前端时才来考虑。实际上后者可能才是真正影响项目成功的关键,也很可能会影响到底层架构的设计和取舍。类比一下,好比一个用户产品都开发完了,才来考虑埋点,数据采集和数据分析的工作,这时候就很被动了。

怎么做:
前期方案文档,没有必要列出详细的技术方案细节,只需要一个整体的技术方向选型和初步的架构设想。但是,如果是涉及到核心需求能否有效满足的关键的技术点,有可能影响整体的架构或产品实现的,那就有必要就可能的方案的进行详细的评估并得出初步的结论。
无关架构或进度安排的方案细节,没有必要写太多,可以后续再补充。
方案中有不明确的地方,即使没有时间调研,也不要简单的略过不写,要在文档中明确的把问题写出来,给出下一步调研的方向计划等。归根唯陆轿到底,方案文档中,对每一个已知重要的问题,都需要一个明确的结论或者可以后续跟进的计划,以免事后遗漏。
再强调一下,做什么和怎么做就是手段,既然是手段,就要写得足够具体,具体到有明确的可落地实施的事情,有明确可以衡量的标准,或者针对当前存在的一个具体问题,不要在这个地方又写得像目标,没有明确的可执行的点。

继续举上文数据交换服务的例子,针对其中的一个核心需求:

ETL业务流程标准化:将最佳实践沉淀下来,通过配置的方式让用户选择,减少重复工作,降低用户开发的难度,规避使用姿势错误可能造成的问题。
这个内容要写具体的要做的事项。以下方式来写可能就是不合格的,因为不够具体,还没有足够思考:

总结最佳实践
生成标准的流程
总结常见的错误
以下内容可能就更加明确,更加可落地一些:

统一当前增量数据导入的存储,合并,归档方案
将常见合并,去重逻辑标准化,通过配置自动生成任务脚本
制定ODS快照表生命周期管理方案,规范存储路径和命名方式,定期清理过期数据。
什么时候做,谁来做:
这是做什么和怎么做的进一步延伸,需要强调的是整个项目如何实施的整体步骤计划,而不仅仅是简单的列一下每项工作的人员和排期,
需要分析系统可能的迭代步骤(包括可能的短期应急和长期解决方案),上下游依赖梳理,需要协同进行的工作,最终项目上线时可能的业务迁移,数据迁移,系统集成等等外围工作的安排。
如果不是工期严格要求,deadline为导向的项目,整体的依赖和步骤往往才是在项目规划阶段需要重点阐述的内容,也是有可能对整体产品的进度,风险产生影响的事项

而具体工作工期的安排,说实话,多数情况下,反到没有那么重要。如果整体工作和步调没考虑周全,工期排得再科学,再精细,也毫无意义。

总结一下,什么时候做什么事,最重要的目的,不在于工期的计算,甚至也不是人力资源的安排,而是为了理顺事情依赖关系,控制可能的意外风险,提升项目开发进度的可控性。

总体原则:

项目方案规划文档的根本目标是统一认识: 明确问题,确定重点,阐明路径,控制风险。
文档的撰写方式,是目标和需求先行,围绕出发点,逐步递进展开。
文档的基本要素: 背景,目标,核心需求,现状问题分析,关键方案难点解析,总体实施路径,工作事项列表,进度计划安排。
再细化到一些注意事项:

核心需求,必须是核心的,一定要实现的内容!不能缺,也不能滥。
问题现状,工作事项,必须呼应核心需求,要有明确的相关性,不要无的放矢。
围绕最终目标,输出完整的端到端的解决方案,而不是局部环节的方案。需要从最终产品/功能形态的角度考虑要做的事,而不是仅仅考虑底层技术实现。
事项目标列表,不要仅仅罗列要做什么事,更重要的是说明想要得到的结果,而不仅仅是描述实现手段。
所有工作事项,需要明确思考过实施步骤,重要性和优先级,结合目标和需求,进行抽象归纳,而非简单随机罗列。
要有明确的计划排期,但更重要的是,要完整的分析思考可能的上下游和周边工作依赖。排期只是结果,完整的梳理才是关键。

㈢ web前端开发都有哪些常见框架结构

随着互联网的不断发展,越来越多的程序员都开始学岁散习和掌握关于web前端开发的相关技术知识。今天,我们就一起来了解一下,web前端开发都有哪些常见框架需要我们了解和掌握的。





一,socket通信


说起web,肯定离不开tcp协议和http协议(https协议较为复杂,暂时不在本章讨论范围之内)。http协议在后面,那什么是tcp协议,cp协议就是网络的传输层面的东西,就是用来传输数据的,tcp协议相对安全可靠,主要连接过程如下图,客户端先发送一个SYN请求,包含一个随机数seq,假设这个随机数的值等于i。服务器就会发送一个ACK请求,并且对这个弊雀饥随机数加1,同时发给客户端,客户端收到服务端的ack之后也会向服务端发送一个ack(这里只是大概描述了一下tcp三次握手,如果想详细了解的话可以去看tcp/ip协议卷)


http是应用层的协议,它的传输层是tcp协议。可以说sock通信是web服务的底层通信,没有socket也就没有http协议,跟谈不上web服务了


二,体系架构


主要有c/s架构和b/s架构,c/s主要由一般需要在客户端安装的应用程序和远程服务器组成的。它的优点是通信双方的通信量较少,因为大部分信息存储在本地,缺点是客户端的维护和升级较为麻烦,一般适用于大型的系统。


b/s架构是由浏览器和服务器组成的,优租返点是方便,随时可以上网,缺点是通信量较大,相对于c/s不是特别的稳定;


c/s架构


b/s架构


三,web应用程序的工作原理


web应用程序大致上分为两种,即动态网站和静态网站。静态网站就是用HTML写的静态页面,动态网站是根据用户不同的请求动态的生成动态的不同的页面发送给客户端,通常使用HTML语言和动态脚本语言(ASP,PHP,JSP)等语言编写。下面的图片来源于网络


在开发Web应用程序时,通常需要应用客户端和服务器端两方面的技术。其中,IT培训认为客户端应用的技术主要用于展现信息内容,而服务器端应用的技术,则主要用于进行业务逻辑的处理和与数据库的交互等。


四,HTTP协议


为了使互联网的web服务茁壮的发展,让客户端和服务端共同的遵守一些协议,http就出现了。http协议可以说是伟大的协议之一,主要有1.0版本,1.1版本和2.0版本。


㈣ 《前端架构设计让前端开发可持续优化、可扩展》pdf下载在线阅读,求百度网盘云资源

《前端架构设计》([美] Micah Godbolt)电子书网盘下载免费在线阅读

资源链接:

链接:

密码:lj2z

书名:前端架构设计

作者:[美] Micah Godbolt

译者:潘泰燊

豆瓣评分:5.8

出版社:人民邮电出版社

出版年份:2017-4

页数:164

内容简介:

本书展示了一名成熟的前端架构师对前端开发全面而深刻的理解。作者结合自己在Red Hat公司的项目实战经历,探讨了前端架构原则和前端架构的核心内容,包括工作流程、测试流程和文档记录,以及作为前端架构师所要承担的具体开发工作,包括HTML、JavaScript和CSS等。

作者简介:

Micah Godbolt

前端架构师,作家,播客播主,世界级开源大会的培训师和演讲师。他在个人博客(https://micahgodbolt.com)中经常大力推广前端架构、Sass、视觉还原测试和基于模式的设计方法。他出生于太平洋西北地区,目前和妻子以及 两个孩子定居于波特兰的郊区。

译者简介:

潘泰燊

毕业于广东外语外贸大学,曾就职于腾讯、网络等互联网公司,参与过腾讯QQ空间、网络地图等海量数据业务的Web开发工作,现就职于富途网络。

张鹏

硕士毕业于中山大学,曾就职于网络、腾讯等知名互联网公司,参与过基于LNMP架构的亿级别互联网应用的设计与实现,目前从事NodeJS与前端开发。

许金泉

毕业于深圳大学,毕业后加入网络FEX,曾主导UEditor、网络国际化浏览器等前端开发工作,现就职于腾讯云。

审校简介:

李弦

华为2012实验室UCD交互设计师,Monash University交互设计硕士,前新东方英语教师,广东外语外贸大学英语专业八级。

㈤ web前端开发开发技术架构有哪些_web前端框架技术概述

前端的应用非常广泛,基本网站、APP、HTML5小程序等都需要前端开发,所以只要是互联网产品基本都需要前端。

前端程序猿切页面写页面,Web上、H5上的炫酷效果,是前端开发大展身手的地方。最常见的用于前端开发的技术组合是:

HTMLCSSJavaScript。

web前端是在开发人员中最直接面向产品、面向用户的设计人员,一个开发团队的成果是要靠web前端去展现,因为用户不会去关心后台的处理有多么强大。

后端开发是写后台,各种业务逻辑、数据处理、模罩蔽块接口、客户端接口等等。后端开发者通常精通于一种Web编程语言和一个数据库管理系统。电商平启握台点击筛选条件下面为你筛选出来的宝贝的功能以及付款人数数据的变化等都是由后台来实现提供的。

目前web产品交互越来越复杂,用户使用体验和网站前端性能优化这些都得靠web前端去做。

前端开发则是物旁州网站的前台代码实现,包括基本的HTML和CSS以及JavaScript/ajax,最新的高级版本HTML5、CSS3,以及SVG等。

前端开发需要学习的技术

1掌握基本web前端开发技术:HTML、CSS、JavaScript、DOM、BOM、AJAX等,而且要了解它们在不同浏览器上的兼容情况、渲染原理和存在的Bug

2必须掌握网站性能优化、SEO和服务器端开发技术的基础知识

3必须学会运用各种web前端开发与测试工具进行辅助开发

4除了掌握技术层面的知识,还要掌握理论层面的知识,包括代码的可维护性、组件的易用性、分层语义模板和浏览器分级支持等

5未来web前端开发工程师还要研究HTML5、web视觉设计、网站配色、网站交互设计模式等相关技术

web前端有广阔的发展空间,app、小程序、移动端、pc端等都网站是需要前端技术的开发支持才能够完成,技术门槛相对较低、需求量较大,薪资待遇良好。只要是互联网端的客户界面,就需要前端来制作完成,前端开发的编程量不大,但是需要部分编程,入门简单,但是要学的深入需要一个过程。