當前位置:首頁 » 網頁前端 » 前端架構開發文檔怎麼寫
擴展閱讀
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端等都網站是需要前端技術的開發支持才能夠完成,技術門檻相對較低、需求量較大,薪資待遇良好。只要是互聯網端的客戶界面,就需要前端來製作完成,前端開發的編程量不大,但是需要部分編程,入門簡單,但是要學的深入需要一個過程。