導入團隊 Project Templates 樣版設計 – (首部曲)


前情提要
先前，小編在 Visual Studio Everywhere 台北場分享了「團隊開發永遠的痛-談導入團隊開發的共同規範」
有些人可能會誤解這只是探討導入 Project Templates 的問題而已，但事實上，在導入 Project Templates 時，並不是為了有 Project Templates 而導入，因為重點不在於 Project Templates 而是在於如何導入團隊共同規範，這不只是可以從基本的 (Coding Standard / Coding Rule) 、與團隊的合作模式來探討如何導入，而且，這還會跟你個人的工作管理有關。
這一篇，會探討為什麼說會跟你個人的工作管理有關？以及這個從個人到團隊的導入要如何來進行，進而建立團隊的 Project Templates 。
為什麼會有這篇文章？筆者打算寫一個長篇，來記錄、順便說明在導入 Project Templates 時，可能會有的一些困難點，怎麼一步步克服，以及該怎麼來進行，技術障礙、問題該怎麼來解決等。
要導入 Project Templates 首先我們得要先了解團隊的狀況，這包含：
  • 團隊的 Skills
  • 現有團隊有無規範 (Coding Standard／Coding Rule／Coding Style) 等等…
  • 使用協同合作工具 (Microsoft Teams／Skype／Slack 等…)
  • 團隊的文化
團隊的 Skills
首先，我們先探討團隊的 Skills，一般來說，我們會認為專案的團隊所需要的 Skills 不需要太高，專案大多是 Team Work 模式，除非你是一人專案 (一人專案暫且不是這篇的討論範圍) ，否則大多有一定的合作模式。這樣聽起來好像說 Skills 不重要？確實，在團隊開發下，個人的 Skills 重要性遠低於團隊的共同守則，所以這也是筆者為什麼會這麼重視團隊要有共同的規範這件事，稍後筆者會探討團隊的文化，這是重要，因為會支撐整個團隊的合作模式。

團隊有無規範 (Coding Standard／Coding Rule／Coding Style)
前面我提到，規範這件事情的重要性遠高於個人的 Skills，為什麼呢？這邊筆者再更詳細加以說明，個人的 Skills 不足，可以藉由標準開發(模板／SPEC／框架／架構)、SA ==> SD 與 program SPEC 讓 PG 在 Method 與 UI 上填補程式碼，這些已經為標準 SOP，也是團隊開發流程成員都具備的共通默的契，所以在客戶需求明確下，PG 不需具備太高的 Skill 即可在這樣的模式下作業，也就是我說的，藉由團隊共通規範也可以隬補工程師 Skill 的不足部分，且工程師也可以由實作過程中，從團隊的規範中學習，並與團隊一同成長。

使用協同合作工具 (VSTS／Microsoft Teams／Skype／Slack 等…)
近年來講求敏捷，筆者目前帶的專案也是採敏捷的方式，但如果是協助客戶端導入，筆者並不刻意強調敏捷的各種好處，因為任何團隊導入敏捷通常不是全盤導入，這有時必須看當時團隊的情況而定，因為敏捷不是銀彈，團隊願意接受改變、或願意嘗試改變會是良好的基礎。
除了良好的基礎外，團隊平常所使用的協同合作工具的角色就非常重要，這裡所提的協同工作所指的不光是企業內部的員工共同討論工作、視訊開會、共同編輯文件等，還包括個人的工作管理、VSTS，恩，對！VSTS，個未發現我把 VSTS 與 Microsoft Teams 放在一起，其實是不一樣的東西，對！是不一樣，沒有錯！只不過，個人的工作管理必須先做好才能夠與團隊內的成員討論共同工作、視訊開會、共同編輯文件時，才會有效率，注意，是說，這樣才會發揮溝通的真正效率，所以我把它放在一起！
試想，個人工作管理不當的情況下，Priority 排序錯誤，討論內容自然會有誤差，這麼一來，其他團隊成員誤解與你整合的順序，那要不是你完成時發現這個需求重點不在這，要不就是做到一半發現應該先做什麼才對，但時間已經浪費，哪你又得重新花一次的溝通成本，協調團隊成員與你配合的部分得要延後，如果同事坐在你後面這成本似乎還好，但大大小小的細節都如此，那就很大的成本。
團隊開發，許多事情都是環環相扣，所以敏捷一開始所提倡的『減少浪費』其實也是在說明這些事情，因為個人的工作管理這些細節部分也會是 Team Work 的基礎。

團隊的文化
這真的是比較難的部分，前面筆者所提的部分，最後我希望能成為團隊合作的習慣、團隊成員都成在其中慢慢獲得好處 (這個好處指的是敏捷的快速反應、專案的透明化 等等) ，進而形成一種自然而然的合作模式、且團隊成員的自我成長會帶動團隊的成長，團隊成員中較 Junior 的工程師會受其影響並自我提升，最後，我期望能成為團隊的文化。

會有哪些步驟？該怎麼進行？
本篇文章想要說明的是，藉由 Project Templates 的導入，導入團隊開發的公同規範，使用一致性的開發方法，如：Coding Standard／Coding Rule／Coding Style 、使用等，所以 Project Templates 在這裡只是工具，真正的重點是一致的開發方法的導入、推動。
但是，團隊共同的開發規範不是一就可及，因為者也是團隊共識問題，那麼該怎麼做，可以分哪幾個步驟來進行呢？

1. 原始檔控制 (Source Control)
這是任何事情的起點，許多事情，先不要提到規範問題，我們主要的產出就是程式碼，若是連主要的產出都沒有妥善的被管理，那麼什麼都不用談。

2. Coding Standard／Coding Rule／Coding Style
透過團隊內部討論，建立一種程式碼撰寫規範，包含程式碼註解撰寫規則，盡量簡單，直覺，但是不可以失去原先的標的 Coding Style，如果程式碼可讀性差，連你自己三個月後來看你自己的程式碼都不是馬上能夠看懂的話，就表示還有檢討的空間。
另外，這時候其實就可試著培養團對成員進行 Code Review 的習慣，但不是要 Challenge 程式碼而製造對立，而是培養工程師互相討論程式碼該怎麼寫，客戶需求該怎麼做，建議可以每一週進行一次，但不要花費太多時間。如果整合 VSTS / TFS 的 Check-In Policy 與 Team Build 會有更好的效果。
詳細 Code Review 方式與 Check-In Policy 可以參考筆者以前的文章：「[StyleCop] 如何設計屬於團隊的 StyleCop Source Analyzer Rule (Coding Standard)」
Front-End 的程式碼規範我們稍後來談，因為 Project Templates 也會包含 Front-End Framework，所以這些都是團隊要討論出共識的部分。

3. 從個人的工作管理 到 團隊
以前，在還沒有 VSTS 時，筆者的公司進行專案時，我們是使用 EXCEL 做個人的工作管理，包含個人每天 Time Card 的填寫，都是使用 EXCEL，甚至個人的（本周／下週）的工作計畫都是使用 EXCEL，但每個人都生出一個 EXCEL 又延伸其他管理問題，雖然，當時的公司請筆者使用 ASP.NET WebForm 開發一套 WKM 工作管理系統，但還是衍伸一個問題，就是沒有辦法像 （VSTS／TFS）的工作項目可以與 Source Code 相關聯的問題，因為當時，TFS 都還沒推出。但在現今，筆者會認為，將簽入的程式碼與 Task 相關連是工程師自身工作管理的一部份，所以，筆者會建議導入 TFS 或是VSTS，因為使用 TFS 或是 VSTS 可以輕易的將個人的工作管理與團隊互相整併，PM 或是 PO 可以隨時掌握專案的執行情況，客戶也能清楚專案的進度，也容易達到敏捷所提倡的透明化。

4. 建立共通架構規範
這與第三點相同，只是軟體開發總是會有架構上的設計，比如分層的方式、延展性、擴充性、共用模組設計、商業邏輯層 （或BO元件）、服務層 （Services Layer）的設計必須要有共通規範，不要太複雜，怎麼切割可能 BY 客戶的產業、Domain Knows-how 有些不同，這個沒有關係，但可以定義出一個基本的分層樣式。企業內部若有資深的 SD 人員或是架構師，可自行規範這個部分，若沒有也可尋求外部講師或是顧問協助提升這個部分。

5. 使用哪一種 Front-End Framework
這是最難管理的一部份，尤其團隊對於 Front-End Framework 的 Skill 都不同的時候，這部分的處理有時可能會導向用教育訓練的方式來進行，這是對於不熟悉的工程師而言，可由熟悉的工程師帶著進行，而先前執行過專案也可以是參考的依據，總而言之，這是未來製作前端 UI 會使用、並包含在 Project Templates 裡面的 Front-End Framework 套件，盡可能凝聚出共識，參考的專案也盡量以含括 基本 CRUD 畫面、查詢、Grid、基本表單、Report 都有包含的專案，先撇除產業的不同，有一個可以包含在 Project Templates 的初版可以即可，那麼之後可以再擴充不同的 Item Templates 到現有的 Project Templates 專案中即可。

結語
這一篇，筆者先探討建立 Project Templates 可能的實作規範與方向供各位參考，下一篇筆者將帶著大家就一個筆者先前實做過的案例來為各位介紹導入與設計的方式。


































留言

張貼留言

這個網誌中的熱門文章

軟體工程師 - 成長的 10 個階段

圖片
軟體工程師 - 成長的 10 個階段 前言 先前，我在 Study4 小聚 #6 分享的一場關於軟體工程師 & 架構設計的養成之路，在該議程中，我分享了軟體工程師的 10 個階段（你的階段如有雷同、應該是...純屬巧合。XDDD） 哪 10 個階段？ 我將軟體工程師的成長依序分為 10 個成長階段，因為隨著技能的提升，你該擴充的 不會只是只有軟體開發技術，溝通與協作能力尤其重要 ，也像是『康威定律』中所提到的， 你的軟件的設計 & 或系統設計本質上反映了企業的組織機構。系統各個模塊間的介面的設計，也反映了企業各個部門之間的信息流動和合作方式，這些技能再進行軟體架構設計時也息息相關 ，團隊在進行模組設計時需要頻繁的溝通，這些、都是是否能將軟體做好的關鍵因素。 如 Logo 圖片，我依序說明每個階段的成長歷程。 1). 初始開發階段、熟悉 Programming/Developer 階段（PM/PO/SD 給規格後加以實作出來），並能夠藉由 模仿 來學習。這是剛進入軟體產業的學習階段。 2). 此階段代表已懂得透過重構來讓程式碼有基本的可維護性 、已能熟用 DRY (Don't Repeat Yourself)，進入這個階段代表已經有基本的程式語言的基礎， 應付 Programming/Developer 日常 工作 上的需求基本上沒什麼太大的問題。 3). 這裡的專案收尾代表對於專案開發已經有某些程度的認知、掌握度。我所提的掌握度在於了解『技術債』的產生緣由 與 危害，在 Programming/Devloper 層面懂得透過 S.O.L.I.D./Design Patterns 解決問題 並 開始能夠 自我學習 + 自我成長 。 4). 我這裡用『紀錄』 代表能運用所學 + 將使用者需求運用 〔邏輯思考〕 與 〔抽象化〕 轉化為程式碼 + 並能 自我成長 將經驗保存下來。我認為這是跨越只是（寫程式／實作）進入另一個門檻的重要經驗與歷練。 這個階段花費的時間會較長一點，時間長短取決於個人歷練、經歷、學習的環境與工作內容。 5). 此階段含括上面所有技能，並能夠與〔團隊〕和〔客戶〕 溝通 與 協作 、並產生出〔產品〕。而所謂的協作代表，不只自身技術所長能應付本身開發工作工作所需，亦能帶領團隊解決軟體專案的大小事務、也能夠替...
閱讀完整內容

常見的程式碼壞味道（Code Smell or Bad Smell）

圖片
常見的程式碼壞味道（Code Smell or Bad Smell） 圖片取自：https://www.slideshare.net/ElMahdiBenzekri/art-of-refactoring-code-smells-and-microservices-antipatterns 前言 究竟重複的程式碼要不要共用它？傳統的軟體開發上，重複的程式碼幾乎被視為罪惡的來源，但是它真的有多可怕？ 常見的 Code Smells The Dispensable （一些可有可無的） Lazy Class (冗員類別） 如果一個類很少使用它會增加代碼庫的複雜性，從而阻礙開發。這樣的類可能是不必要的，它的功能可以成為另一個類的一部分。 Data Class (只有資料的類別） 一個類別只有包含『資料』未包含Methods，也就是說並未包含行為，不具行為模式的類別代表該『實例』容易被【其他類別所操控】。 Duplicate Code (重複的程式碼) 如描述，這也是上次有分享在我的 FB 社團 軟體開發之路［德國資深架構師給新手的建議］ 中有產生非常熱烈討論，這在社團朋友提醒下想起 Refactor 重構一書裡曾提過 rule of three 法則， 這個法則的定義是這樣的，有時部分程式碼重複其實是允許的（不是說重複一定是是被允許的）而是在某些 Context 情境下，該程式碼有一段時間不會衍伸別的功能 或 需求一段時間不會異動、且如要將它 DRY 會產生的『複雜度』或『花費時間』遠高於預估的時間 或 不值得在目前這個專案的節骨眼上花費這個時間來做這件事，加上它 DRY 產生的複雜度偶後產生的維護成本【遠高於】不 DRY 的情況下的維護本，那麼，在這個時候，這個異動頻率【極低】的程式碼就不需要花費這個時間來 DRY 了！！ 因為重點在於，重構是需要『成本』的。(迷之音：DRY 是種抽象化阿~😎) 這讓我想起之前，大約在 2016 年左右，在 101 的樓上某金融業客戶，曾經做過一個專案，這個專案就是因為客戶 DMZ 環境的因素，我讓內網的 Webside 與 DMZ 的網站保留了部分重複的程式碼，因為這段程式碼終年不需要異動，我也懶得花這個時間，而我居然也忘了這記件事情了.. 哈哈 Orz 不過原歸正傳，我個人還是認為，其實適當...
閱讀完整內容

什麼是 gRPC ？

圖片
圖片取自： https://grpc.io/docs/guides/ gRPC 是什麼？能吃嗎？ 在安裝了 .NET Core 3.0 之後，眼尖的朋友應該會發現，在新增 ASP.NET Core 網頁類型專案裡，會看見一個 gRPC Service 類型的專案，其實它也不是什麼很新的東西，早在十多年前 Google 就使用這樣的 RPC 協定進行一些大量的可靠性微服務的存取，聽到這，難道現有的 Web API 不可靠嗎？其實不是的，它主要用在移動設備等提供高效簡單且跨平台的通訊與熱插拔的驗證機制。 gRPC 的運作原理 gRPC 顧名思義，是種基於 RPC 的通訊協定，不同於 Web API 走的傳統 HTTP 基礎協定，它有點像是 Socket ，但應該說是基於 Socket， 或精確地來說它是基於 HTTP/2 的協定 ，gRPC 是種協議緩衝協定，它必須事先定義 IDL (Interface Definition Language) 描述檔，看到 IDL 對於一些熟悉 COM／DCOM 的朋友一定非常的熟悉，對！沒錯！就是類似的東西！但，這邊的 IDL 是用一種副檔名為 .proto 檔案來是先定義在分散式環境中，要傳輸的序列化結構資訊，當然它也可以跟 JSON 一起使用。 也就是說，要使用 gRPC 您必須先定義 .proto 協議，然後透過 Compile 的支援，編譯成特定語言框架。而很高興的是，C# 也支援了，然而其實根據官方的資料顯示，C# 應該在 .NET Core 2.1 開始就支援了，只是到了 .NET Core 3.0 才有樣版的支援。 而使用 gRPC 的協議緩衝區的服務可以做到 Stub 的機制，也就是說，它就像是許多 RPC 一樣，Client 在呼叫 Server 端時，其實是對 Stub 進行叫用，Stub 在這就像個緩衝區一般，但更細部的說，應該是一個遠程服務的替身，這應該又讓許多熟悉 COM／RPC 通訊的朋友覺得熟悉了起來，是的！沒有錯。 在 .NET Core 3.0 裡使用 gRPC 目前支援 .proto 擴展為 gRPC 協議緩衝區的編譯器只有 .NET Core 了 ， 根據 Github 上的說明 .NET Framework 4.5+ 以上或 Mono 4+ 以上也可支援，而 gRPC 也完全的跨平台。要在 ....
閱讀完整內容