定義規格

從定義規格開始,是開始開發一個功能的首要之務,沒有規格就沒有明確的需求,溝通與討論沒有依據,沒有規格的開發容易開發出預期外的功能造成浪費。

但規格定義該從何開始?可分三個部分進行。

  • input:從前端或是第三方預期輸入的參數
  • endpoint:函數或是 rest api 的接口的命名,input 傳入 parameter 的定義。
  • output:透過 endpoint 的呼叫,預期會產生怎樣的輸出結果。

一般來說,在定義規格時,決不是前端或是後端說的算,而是要一起定義,討論出最可行的規格,若有搭配 SA 人員,可在對最後的規格進行確認。

就跟開始開發一個函式一樣,規格定義也是相同的,差別是在於規格定義尚未實作,程序上來說,這階段只會讓相關人員確認相關規格是否可以做到,在開始開發前,先進行討論,假若有需要調整的地方可再變更規格,直到負責相關功能的人員都認同才進行開發。

除了專案內的規格定義外,若是串接第三方 API 或是使用第三方 module 也可以透過定義規格,來確保運作如預期。

第三方 API

比如串接 facebook api,以 facebook 的更新習慣,幾乎一個禮拜就會有新的版本,要怎麼確保所有接口運行如預期?

同樣的可以定義規格,定義輸入的參數與期望的輸出,確保系統運作與期望的一樣,一旦發生異常,可以立即修正

第三方 module

使用第三方套件,同樣的也有更新問題,我們同樣可以為他定義規格,確保每一次更新我方使用的函式並未超出預期,並且運作正常。

規格定義不只是防堵,或是確認運作是否如預期,更是一種學習的方法或是知識分享,一旦串接第三方 API 或是 module 所撰寫的規格,每一個都是使用的方法說明,能夠很清楚的知道該如何進行應用,交由其他人協助時也能一目瞭然,定義規格正是一舉數得,不重覆浪費的事情。

results matching ""

    No results matching ""