開發要不要寫文件?
很多人都常常掛在嘴邊,公司沒有文件、開發要寫文件、寫文件很浪費時間⋯⋯
我的觀點不一定套用在你身上合理,也不是非黑即白的對錯問題,只是我想分享我的想法。
我認為接案性質或是產品用過即丟的不需要寫文件。但凡需要長期維護、使用、敏捷追加功能等等,都非常需要文件。
很多工程師會有迷思,何謂開發文件?
難道要寫「這段程式幹嘛」這樣的描述?
我認為不需要,真正需要寫的是「這裡要達到的目的」,怎麼做?不重要。因為程式碼是會重構和迭代,你現在覺得最好的方法不見得永遠是最好的,那這樣的文件價值很低。真正要寫的的「目的」和「規格」,特別是「你解決的邊際問題」。
所以我認為最重要的是 Spec。
但 PM 表示,文件大家都不看,寫心酸的?
文件不是給當下開發的人看的,當下大家都用「溝通」的,因為比較方便和快速。但文件是給「後手」和「未來的自己」看的,人類的記憶力真的沒有很好,隔一段時間就會遺忘,人員也是會流動的,這時候文件就可以發揮作用。
但何謂 Spec?
不管是客戶需求的紀錄、功能的需求規格、UI 的設計稿、套件的 API 、服務的 API等等,但凡你的產出需要跨部門、跨職能、跨團隊溝通請另一方實作產品某個環節,那就需要的文件。
你怎麼看呢?