怎么看待一些后端程序員不寫接口文檔?
這種現象普遍存在,尤其是一些小公司。根本就沒有這么多時間來寫這玩意,因為需求隨時改。很多公司一開始也是堅持寫接口文檔,寫著寫著就不寫了。原因有以下幾點:
一、需求改動太頻繁寫借口文檔無形中縮短前后端聯調接口的時間。前后端定義好,然后就按照接口定義來走,減少了溝通成本。新接手的人也知道該怎么規范起來。但理想很豐滿,現實很骨感。有一句話說得好,做開發的永遠不要相信產品的話,一個項目就是在不斷的更改中才會慢慢的成長。即便是非常優秀的產品經理,他也無法阻擋需求的更改。優秀的產品經理只能說避免很多沒有必要的需求,考慮的更全面一點。
一旦需求改的太頻繁,需求多了,也就是忙起來了,寫代碼的時間都不夠,就不會寫什么接口文檔了。直接把接口告訴前端,前端再打印出來,看看是什么格式,然后根據需要傳的參數來進行聯調。其中遇到什么問題就再反饋給后端。
隨著這樣的習慣,慢慢的后端就更不寫接口詳細文檔了。不過這樣有一個弊端,那就是有人員變動的時候,這參與進來的成本就大很多。更何況每個人寫代碼的風格不太一樣。
二、沒這個要求、沒這個習慣其實聯調接口,對著文檔來,真的是減少了前端的開發工作量。但是很多公司技術部門老大沒有這方面的規定。所以誰都想能偷懶就偷懶,你前端人員讓他們寫,他們是不會聽你的。因為你不是他們的老大。
我上家公司就是這樣,后端有四個人,每個人寫的接口格式都不一樣。同樣的一個字段名,有的人是這個單詞,有的人是那個單詞,甚至有的人類型都不一樣,他們從來也沒有寫接口需求的習慣。因為前幾年前后端分離不是那么火,前端做的工作僅僅就是把設計師設計的圖,然后切成靜態頁面。然后丟給后端,后端聯調接口就不需要什么接口文檔了。后端怎么寫的他自己都知道。
三、不想背鍋因為寫接口文檔不僅僅規范起來,其實也是一個證據的證明。如果后端的人開始寫了這個定義,后面沒有按照這個來,出了問題,到時候鍋想甩都甩不掉。
另外直接說不想寫,到時候你告訴領導,寫文檔是那個人不想寫,估計也少不了一頓批。以忙為由,這樣領導聽起來就可以理解。
個人觀點我個人覺得很有必要把這個需求文檔規范起來,既然大家是一個團隊,如果不規范起來,這樣不僅不能提高開發效率,反而后期出現的問題也會越來越多。團隊是需要磨合的,而不是隨心所欲的,團隊不磨合,那這個團隊永遠不會強大起來,甚至可以說是一盤散沙。
規范不是按照一個人的的意思來,而是大家都提出有用的建議,把各個人的優點都集中起來。然后大家都按照這個規則按一處使勁,這樣的產品才會越來越好。你覺得呢?